Skip to content

Commit

Permalink
Updated documentation for editParsing
Browse files Browse the repository at this point in the history
  • Loading branch information
Jacob Daniel Bennett committed Oct 22, 2020
1 parent ce7c4d5 commit 96b2e05
Showing 1 changed file with 19 additions and 2 deletions.
21 changes: 19 additions & 2 deletions api/ECNQueue.py
Original file line number Diff line number Diff line change
Expand Up @@ -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 = {}

Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 96b2e05

Please sign in to comment.