mirror of
https://github.com/iluvcapra/pycmx.git
synced 2025-12-31 00:40:57 +00:00
documentation
This commit is contained in:
@@ -34,13 +34,14 @@ Features
|
||||
Getting Started
|
||||
----------------
|
||||
|
||||
Install `pycmx` with pip.
|
||||
Install `pycmx` with pip, or add it with `uv` or your favorite tool.
|
||||
|
||||
.. code-block:: sh
|
||||
|
||||
pip install pycmx
|
||||
|
||||
`pycmx` parses an EDL with the :func:`pycmx.parse_cmx_events.parse_cmx3600` function:
|
||||
`pycmx` parses an EDL with the :func:`~pycmx.parse_cmx_events.parse_cmx3600`
|
||||
function:
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
@@ -49,6 +50,10 @@ Install `pycmx` with pip.
|
||||
with open("tests/edls/TEST.edl") as f:
|
||||
edl = pycmx.parse_cmx3600(f)
|
||||
|
||||
This returns a generator tha will yield each :class:`~pycmx.event.Event`.
|
||||
Events can have multiple edits, if they are a part of a cross-dissolve oe a
|
||||
key.
|
||||
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 5
|
||||
|
||||
@@ -52,7 +52,7 @@ class Edit:
|
||||
@property
|
||||
def transition(self) -> Transition:
|
||||
"""
|
||||
Get the :obj:`Transition` object associated with this edit.
|
||||
Get the :obj:`Transition` that initiates this edit.
|
||||
"""
|
||||
if self._trans_name_statement:
|
||||
return Transition(self._edit_statement.trans,
|
||||
|
||||
Reference in New Issue
Block a user