Updated docstrings and added an important note

umbra/model.py

@@ -52,6 +52,11 @@ class Model:
             ShadowTask(pnr, vnr, condition, source, shadow))
 
     def create_delay_frame(self):
+        """Create the frame for displaying delays.
+
+        Returns:
+             The dataframe with delays
+        """
         delay_frame = ({'participant': [],
               'assignment': [],
               'video': [],

umbra/statistics.py

@@ -86,6 +86,8 @@ class Statistics:
         trial.results = self._mistake_counter.\
             calculate_accuracy(source_em, shadow_em)
 
+        #IMPORTANT: This will not work on source_em because the matching is
+        # the other way around.
         delays_per_word = []
         for source_word in source:
             if source_word.has_shadow():

umbra/utils.py

@@ -57,14 +57,15 @@ class Utils:
 
     @staticmethod
     def shadow_regex(path, video):
-        """Find the reduced path based on the participant and video numbers
+        """Find the reduced path based on the video number
 
         Args:
             path: the shadow path to check
             video: the video number
 
         Returns:
-            the reduced path
+            participant: the participant number
+            task: the task for the participant
         """
         match = re.search(f"(\d+)_(\D+){video}+\.T", path)
         task = None