diff --git a/README.md b/README.md index 54a792a..10e9bbd 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,8 @@ The `pycmx` package parses a CMX 3600 EDL and its most most common variations. read. Event number field and source name field sizes are determined dynamically for each statement for a high level of compliance at the expense of strictness. +* An more relaxed "tolerant" mode allows parsing of an EDL file where columns + use non-standard widths. * Preserves relationship between events and individual edits/clips. * Remark or comment fields with common recognized forms are read and available to the client, including clip name and source file data. diff --git a/docs/source/index.rst b/docs/source/index.rst index dd3de15..08a8169 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,7 +1,7 @@ .. pycmx documentation master file, created by sphinx-quickstart on Wed Dec 26 21:51:43 2018. You can adapt this file completely to your liking, but it should at least -contain the root `toctree` directive. + contain the root `toctree` directive. pycmx - A CMX EDL Parser in Python ==================================== @@ -16,6 +16,8 @@ The `pycmx` package parses a CMX 3600 EDL and its most most common variations. read. Event number field and source name field sizes are determined dynamically for each statement for a high level of compliance at the expense of strictness. +* An more relaxed "tolerant" mode allows parsing of an EDL file where columns + use non-standard widths. * Preserves relationship between events and individual edits/clips. * Remark or comment fields with common recognized forms are read and available to the client, including clip name and source file data. diff --git a/pycmx/parse_cmx_events.py b/pycmx/parse_cmx_events.py index a0716ae..10bd142 100644 --- a/pycmx/parse_cmx_events.py +++ b/pycmx/parse_cmx_events.py @@ -12,8 +12,8 @@ def parse_cmx3600(f: TextIO, tolerant: bool = False) -> EditList: Parse a CMX 3600 EDL. :param TextIO f: a file-like object, an opened CMX 3600 .EDL file. - :param bool tolerant: If `True`, a relaxed event line recognition method - will be used in the case the stricter default method fails. + :param bool tolerant: If `True`, a relaxed event line parsing method will + be used, in the case the default method fails. :returns: An :class:`pycmx.edit_list.EditList`. """ statements = parse_cmx3600_statements(f, tolerant)