Skip to content

Commit 003ab04

Browse files
authored
Fix typos (#1821)
Signed-off-by: Dimitris Apostolou <[email protected]>
1 parent 68d891a commit 003ab04

25 files changed

+127
-128
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ commandline by using the `CMAKE_ARGS` environment variable.
174174

175175
`env CMAKE_ARGS="-DCMAKE_VAR=VALUE1 -DCMAKE_VAR_2=VALUE2" pip install .`
176176

177-
Additionaly, to reproduce CI failures regarding the file manifest, run:
177+
Additionally, to reproduce CI failures regarding the file manifest, run:
178178
`make manifest` locally to run the python `check-manifest` program.
179179

180180
## C++ Coverage Builds

docs/cxx/cxx.rst

+7-7
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ straightforward and uncontroversial.
3838

3939
Reminder: these
4040
`sample header files <https://github.com/davidbaraff/OpenTimelineIO/tree/master/proposed-c%2B%2B-api/opentime>`_
41-
exist only to show the API; namespacing and other niceties are ommitted.
41+
exist only to show the API; namespacing and other niceties are omitted.
4242

4343
Starting Examples
4444
+++++++++++++++++
@@ -82,7 +82,7 @@ already defines properties ``name`` and ``metadata``: ::
8282
std::color _color;
8383
};
8484

85-
The contructor takes four properties, two of which (``marked_range`` and
85+
The constructor takes four properties, two of which (``marked_range`` and
8686
``color``) are stored directly in ``Marker``, with the remaining two (``name``
8787
and ``metadata``) handled by the base class ``SerializableObjectWithMetadata``.
8888

@@ -146,7 +146,7 @@ details above as appropriate for your case.
146146
Properties are written to the JSON file in the order they are written
147147
to from within ``write_to()``. But the reading code need not be in the same order,
148148
and changes in the ordering of either the reading or writing code will not
149-
break compatability with previously written JSON files.
149+
break compatibility with previously written JSON files.
150150

151151
However, it is vital to invoke ``Parent::read_from()`` *after* reading all
152152
of the derived class properties, while for writing ``Parent::write_to()``
@@ -155,7 +155,7 @@ details above as appropriate for your case.
155155
.. Note::
156156
Also note that the order of properties within a JSON file for data
157157
that is essentially a ``std::map<>`` (see ``AnyDictionary`` below)
158-
is always alphebetical by key. This ensures deterministic JSON file
158+
is always alphabetical by key. This ensures deterministic JSON file
159159
writing which is important for comparison and testing.
160160

161161
Using Schemas
@@ -193,7 +193,7 @@ to JSON is transported as a C++ ``any``. What can that ``any`` hold?
193193
First, the ``any`` can be empty, which corresponds with a ``null`` JSON value.
194194
The ``any`` could also hold any of the following "atomic" types: ``bool``,
195195
``int``, ``double``, ``std::string``, ``RationalTime``, ``TimeRange`` and
196-
``TimeTransform``. All but the last three are immediately expressable in JSON,
196+
``TimeTransform``. All but the last three are immediately expressible in JSON,
197197
while the three Opentime types are read/written as compound structures with the
198198
same format that the current Python implementation delivers. The final
199199
"atomic" type that an ``any`` can hold is a ``SerializableObject*``, which
@@ -323,7 +323,7 @@ Memory Management
323323
+++++++++++++++++
324324

325325
The final topic we must deal with is memory management. Languages like Python
326-
and Swift natually make use of reference counted class instances. We considered
326+
and Swift naturally make use of reference counted class instances. We considered
327327
such a route in C++, by requiring that manipulations be done not in terms of
328328
``SerializableObject*`` pointers, but rather using
329329
``std::shared_ptr<SerializableObject>`` (and the corresponding
@@ -679,7 +679,7 @@ What makes this complicated is the following set of rules/constraints:
679679
virtue of a Python wrapper instance P being constructed from Python. Until that C++ object X
680680
is passed to C++ in some way, then X will exist only as long as P does.
681681

682-
How can we satisfy all these contraints, while ensuring we don't create retain
682+
How can we satisfy all these constraints, while ensuring we don't create retain
683683
cycles (which might be fixable with Python garbage collection, but also
684684
might not)? Here is the solution we came up with; if you have an alternate
685685
suggestion, we would be happy to hear it.

docs/tutorials/adapters.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ The OpenTimelineIO native file format adapters that are present in the `opentime
1212

1313
## Batteries-Included Adapters
1414

15-
To also install a curated list of additional useful adapters, use the [OpenTimelineIO-Plugins ](https://pypi.org/project/OpenTimelineIO-Plugins/) python package. In addition to the OpenTimelineIO native adapters, you'll get aditional useful adapters including:
15+
To also install a curated list of additional useful adapters, use the [OpenTimelineIO-Plugins ](https://pypi.org/project/OpenTimelineIO-Plugins/) python package. In addition to the OpenTimelineIO native adapters, you'll get additional useful adapters including:
1616

1717
- [AAF](https://github.com/OpenTimelineIO/otio-aaf-adapter)
1818
- [ale](https://github.com/OpenTimelineIO/otio-ale-adapter)

docs/tutorials/contributing.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Here are the two possible CLAs:
1919
Please follow the coding convention and style in each file and in each library when adding new files.
2020

2121
## Platform Support Policy
22-
As recomended by the [VFX Platform](https://vfxplatform.com) (see "Support Guidance"), we support the intended calendar year of the release as well as the three prior years.
22+
As recommended by the [VFX Platform](https://vfxplatform.com) (see "Support Guidance"), we support the intended calendar year of the release as well as the three prior years.
2323

2424
## Git Workflow
2525
Here is the workflow we recommend for working on OpenTimelineIO if you intend on contributing changes back:

docs/tutorials/otio-filebundles.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ When a bundle is read from disk using the OpenTimelineIO Python API (using the a
6262

6363
For example, to view the timeline (not the media) of an otioz file in `otioview`, you can run:
6464

65-
`otioview sommething.otioz`
65+
`otioview something.otioz`
6666

6767
Because this will _only_ read the `content.otio` from the bundle, it is usually a fast operation to run. None of the media is decoded or unzipped during this process.
6868

0 commit comments

Comments
 (0)