From 90b0da898711ab5ecf08574b6a87fd139cf62387 Mon Sep 17 00:00:00 2001 From: Jacob Daniel Bennett Date: Wed, 21 Oct 2020 23:18:29 -0400 Subject: [PATCH] Updated documentation for statusParsing --- api/ECNQueue.py | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/api/ECNQueue.py b/api/ECNQueue.py index d9c1b45..846bfaa 100644 --- a/api/ECNQueue.py +++ b/api/ECNQueue.py @@ -612,10 +612,21 @@ def __replyToParsing(self, content: list, lineNum: int) -> dict: def __statusParsing(self, content: list, lineNum: int) -> dict: """Returns a dictionary with status information + Example: + *** Status updated by: campb303 at: 6/23/2020 13:26:55 ***\n + Dont Delete\n + + Args: + content (list): The content of a status update + lineNum (int): The line number of a status update in an item + Returns: - dictionary: "type": "status", by, datetime and content + dict: a dictionary with these keys, + "type": "status", + "by": initiator of the status update, + "datetime": datetime of the status update, + "content": content of the status update """ - statusInfo = {} statusInfo["type"] = "status"