Skip to content

Commit

Permalink
updated assignmentParsing documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Jacob Daniel Bennett committed Oct 22, 2020
1 parent b9e7800 commit a5979b4
Showing 1 changed file with 20 additions and 1 deletion.
21 changes: 20 additions & 1 deletion api/ECNQueue.py
Original file line number Diff line number Diff line change
Expand Up @@ -423,11 +423,30 @@ def __directoryParsing(self, directoryStartLine: int) -> dict:
# Returns the directory information dictionary
return directoryInformation

def __assignmentParsing(self, contentStart) -> list:
def __assignmentParsing(self, contentStart: int) -> list:
"""Returns a list with assignment information dictionaries
Example:
Assigned-To: campb303
Assigned-To-Updated-Time: Tue, 23 Jun 2020 13:27:00 EDT
Assigned-To-Updated-By: campb303
Args:
contentStart (int): line number where the content starts
Returns:
list: [
{"type": "assignment",
"datetime": datetime of the assignment,
"by": user who initiated the assignment,
"to": user who was assigned
},
]
"""
#Returns a list with assignment information dictionaries

#Returns:

assignmentList =[]

# Assignment Information
Expand Down

0 comments on commit a5979b4

Please sign in to comment.