Skip to content

Commit

Permalink
Updated documentation for statusParsing
Browse files Browse the repository at this point in the history
  • Loading branch information
Jacob Daniel Bennett committed Oct 22, 2020
1 parent 2af7da5 commit 90b0da8
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions api/ECNQueue.py
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down

0 comments on commit 90b0da8

Please sign in to comment.