From ebc288defe4896dfe1670eaab085ee8637f232a2 Mon Sep 17 00:00:00 2001
From: Rob Hallam <0504004h@student.gla.ac.uk>
Date: Fri, 19 Jul 2024 11:27:20 +0100
Subject: [PATCH] doc: expand Source docstring

---
 pipeline/utils.py | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/pipeline/utils.py b/pipeline/utils.py
index c3331be..65af770 100644
--- a/pipeline/utils.py
+++ b/pipeline/utils.py
@@ -34,6 +34,24 @@ class Source():
         "path": "/path/to/video.mp4",
         "provider": "FileInputJSON"
     }
+
+    Instance variables:
+
+    source -- the source of the media file (eg, a URL or a local path)
+    path -- the path to the media file
+    provider -- the provider of the media file (eg, "FileInputJSON")
+
+    Accessing the object should return the path to the media file.
+
+    Methods:
+
+    duration() -- return the duration of the media file (uses ffprobe, result is cached)
+
+    Notes:
+     - source and path may be the same, for example in the case of a local file
+    """
+    _duration = None
+
     def __init__(self, source, path, provider):
         if not source:
             raise ValueError("Source must be provided") # TODO: #API -- decide if this is necessary