docs: add some more documentation

escaped · Nov 15, 2020 · 1af89ba · 1af89ba
1 parent 346c2d8
commit 1af89ba
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/video_encoding/tasks.py b/video_encoding/tasks.py
@@ -76,7 +76,7 @@ def _encode(
     Encode video and continously report encoding progress.
     """
     # TODO do not upscale videos
-    # TODO move logic git VideoFormat class
+    # TODO move logic to Format model
 
     with tempfile.NamedTemporaryFile(
         suffix='_{name}.{extension}'.format(**options)

diff --git a/video_encoding/utils.py b/video_encoding/utils.py
@@ -8,6 +8,9 @@
 
 @contextlib.contextmanager
 def get_local_path(fieldfile: File) -> Generator[str, None, None]:
+    """
+    Get a local file to work with from a file retrieved from a FileField.
+    """
     if not hasattr(fieldfile, 'storage'):
         # Its a local file with no storage abstraction
         try: