Some documentation and autopep

This commit is contained in:
Jamie Hardt
2025-01-05 11:32:23 -08:00
parent 1e1331eadb
commit 8bb6dad1da
3 changed files with 94 additions and 72 deletions

View File

@@ -8,11 +8,11 @@ from .edit_list import EditList
from typing import TextIO
def parse_cmx3600(f: TextIO):
def parse_cmx3600(f: TextIO) -> EditList:
"""
Parse a CMX 3600 EDL.
:param TextIO f: a file-like object, anything that's readlines-able.
:param TextIO f: a file-like object, an opened CMX 3600 .EDL file.
:returns: An :class:`pycmx.edit_list.EditList`.
"""
statements = parse_cmx3600_statements(f)