From a5979b477b8b76005576508da1ae50a776a5bb69 Mon Sep 17 00:00:00 2001 From: Jacob Daniel Bennett Date: Wed, 21 Oct 2020 23:35:30 -0400 Subject: [PATCH] updated assignmentParsing documentation --- api/ECNQueue.py | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/api/ECNQueue.py b/api/ECNQueue.py index 49454ba..8418770 100644 --- a/api/ECNQueue.py +++ b/api/ECNQueue.py @@ -423,11 +423,30 @@ def __directoryParsing(self, directoryStartLine: int) -> dict: # Returns the directory information dictionary return directoryInformation - def __assignmentParsing(self, contentStart) -> list: + def __assignmentParsing(self, contentStart: int) -> list: """Returns a list with assignment information dictionaries + Example: + Assigned-To: campb303 + Assigned-To-Updated-Time: Tue, 23 Jun 2020 13:27:00 EDT + Assigned-To-Updated-By: campb303 + + Args: + contentStart (int): line number where the content starts + Returns: + list: [ + {"type": "assignment", + "datetime": datetime of the assignment, + "by": user who initiated the assignment, + "to": user who was assigned + }, + ] """ + #Returns a list with assignment information dictionaries + + #Returns: + assignmentList =[] # Assignment Information