doc twiddles

README.md

@@ -37,7 +37,7 @@ The `pycmx` package parses a CMX 3600 EDL and its most most common variations.
 ### Opening and Parsing EDL Files
 ```
 >>> import pycmx
->>> with open("tests/edls/TEST.edl") as f
+>>> with open("tests/edls/TEST.edl") as f:
 ... 	edl = pycmx.parse_cmx3600(f)
 ...
 >>> edl.title

src/pycmx/edit.py

@@ -35,7 +35,6 @@ class Edit:
         asc_sat_statement: Optional[StmtCdlSat] = None,
         frmc_statement: Optional[StmtFrmc] = None,
     ) -> None:
-        # Assigning types for the attributes explicitly
         self._edit_statement: StmtEvent = edit_statement
         self._audio_ext: Optional[StmtAudioExt] = audio_ext_statement
         self._clip_name_statement: Optional[StmtClipName] = clip_name_statement
@@ -51,8 +50,8 @@ class Edit:
     def line_number(self) -> int:
         """
         Get the line number for the "standard form" statement associated with
-        this edit. Line numbers a zero-indexed, such that the
+        this edit. Line numbers a zero-indexed, such that the "TITLE:" record
-        "TITLE:" record is line zero.
+        is line zero.
         """
         return self._edit_statement.line_number
 
@@ -180,7 +179,7 @@ class Edit:
     @property
     def asc_sop_raw(self) -> Optional[str]:
         """
-        ASC CDL Slope-Offset-Power statement raw line
+        ASC CDL Slope-Offset-Power statement raw line.
         """
         if self._asc_sop_statement is None:
             return None
@@ -190,7 +189,7 @@ class Edit:
     @property
     def asc_sat(self) -> Optional[float]:
         """
-        Get ASC CDL saturation value for clip, if present
+        Get ASC CDL saturation value for clip, if present.
         """
         if self._asc_sat_statement is None:
             return None

src/pycmx/edit_list.py

@@ -12,7 +12,7 @@ from typing import Any, Generator
 class EditList:
     """
     Represents an entire edit decision list as returned by
-    :func:`~pycmx.parse_cmx3600()`.
+    :func:`~pycmx.parse_cmx_events.parse_cmx3600()`.
     """
 
     def __init__(self, statements: list):

src/pycmx/statements.py

@@ -5,8 +5,6 @@ from typing import Any, NamedTuple
 
 from .cdl import AscSopComponents
 
-# type str = str
-
 
 class StmtTitle(NamedTuple):
     title: str

src/pycmx/transition.py

@@ -24,7 +24,7 @@ class Transition:
     @property
     def kind(self) -> Optional[str]:
         """
-        Return the kind of transition: Cut, Wipe, etc
+        Return the kind of transition: Cut, Wipe, etc.
         """
         if self.cut:
             return Transition.Cut
@@ -56,7 +56,8 @@ class Transition:
 
     @property
     def effect_duration(self) -> int:
-        """The duration of this transition, in frames of the record target.
+        """
+        The duration of this transition, in frames of the record target.
 
         In the event of a key event, this is the duration of the fade in.
         """