From 96b2e05716b94f520d4a54216d0dd38da5559b3d Mon Sep 17 00:00:00 2001 From: Jacob Daniel Bennett Date: Wed, 21 Oct 2020 23:27:53 -0400 Subject: [PATCH] Updated documentation for editParsing --- api/ECNQueue.py | 21 +++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) diff --git a/api/ECNQueue.py b/api/ECNQueue.py index 95e62d8..092a102 100644 --- a/api/ECNQueue.py +++ b/api/ECNQueue.py @@ -533,9 +533,26 @@ def __initialMessageParsing(self, content: list) -> dict: def __editParsing(self, content: list, lineNum: int) -> dict: """Returns a dictionary with edit information + Example: + *** Edited by: campb303 at: 06/23/20 13:27:56 ***\n + \n + This be an edit my boy\n + \n + \n + \n + + Args: + content (list): content of an edit + lineNum (int): line number of an edit within an item + Returns: - dictionary: "type": "edit", by, datetime and content + dict: a dictionary with these keys, + "type": "edi", + "by": initiator of the edit, + "datetime": datetime of the edit, + "content": content of the edit """ + # Edit Info dictionary editInfo = {} @@ -588,7 +605,7 @@ def __replyToParsing(self, content: list, lineNum: int) -> dict: Returns: dict: a dictionary with these keys, - "type": "status", + "type": "reply_to_user", "by": initiator of the reply to user, "datetime": datetime of the reply to user, "content": content of the reply to user