From ce7c4d5d93a320e6900190cfcae6b0bf237e6be8 Mon Sep 17 00:00:00 2001 From: Jacob Daniel Bennett Date: Wed, 21 Oct 2020 23:24:39 -0400 Subject: [PATCH] Updated documentation for replyToParsing --- api/ECNQueue.py | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/api/ECNQueue.py b/api/ECNQueue.py index 846bfaa..95e62d8 100644 --- a/api/ECNQueue.py +++ b/api/ECNQueue.py @@ -573,10 +573,26 @@ def __editParsing(self, content: list, lineNum: int) -> dict: def __replyToParsing(self, content: list, lineNum: int) -> dict: """Returns a dictionary with reply to user information + Example: + *** Replied by: campb303 at: 06/23/20 13:28:18 ***\n + \n + This be a reply my son\n + \n + Justin\n + ECN\n + \n + + Args: + content (list): content of a reply to user + lineNum (int): line number of a reply to user in an item + Returns: - dictionary: "type": "replyToUser", by, datetime and content + dict: a dictionary with these keys, + "type": "status", + "by": initiator of the reply to user, + "datetime": datetime of the reply to user, + "content": content of the reply to user """ - replyInfo = {} replyInfo["type"] = "reply_to_user"