added docstring to __get_assignments

ECN · Jul 1, 2021 · 5383f8f · 5383f8f
1 parent a84d8e7
commit 5383f8f
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/src/webqueue2api/parser/item.py b/src/webqueue2api/parser/item.py
@@ -313,6 +313,14 @@ def __get_sorted_sections(self, sectionsList: list) -> list:
         return sortedSections
 
     def __get_assignments(self) -> list:
+        """Returns a list of dictionaries containing assignments
+
+        Example:
+                
+
+        Returns:
+                list: list of dictionaries which represent assignment sections
+        """        
         assignment_list = []
 
         for index, header in enumerate(self.headers):