From 5383f8f55856e821fe4119e15932bc79f343ebd4 Mon Sep 17 00:00:00 2001 From: benne238 Date: Thu, 1 Jul 2021 11:50:29 -0400 Subject: [PATCH] added docstring to __get_assignments --- src/webqueue2api/parser/item.py | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/src/webqueue2api/parser/item.py b/src/webqueue2api/parser/item.py index fcef549..4883676 100644 --- 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):