added docstring to __parse_sections

ECN · Jul 1, 2021 · 23abdf3 · 23abdf3
1 parent 5383f8f
commit 23abdf3
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/src/webqueue2api/parser/item.py b/src/webqueue2api/parser/item.py
@@ -218,6 +218,14 @@ def __parse_headers(self) -> list:
         return headers
 
     def __parse_sections(self) -> list:
+        """Generates a list of dictionaries which represent all the secctions in an item
+
+        Example:
+                [example]
+
+        Returns:
+                list: list of dictionaries, which all containt a type key to deliminate what type of section the dictionary represents
+        """        
         # Convert list of lines to single string
         raw_item_as_string = "".join(self.__raw_item)