Skip to content

Commit

Permalink
Add Item class doc block
Browse files Browse the repository at this point in the history
  • Loading branch information
Justin Campbell committed Oct 29, 2020
1 parent 0c28cfe commit a507ac7
Showing 1 changed file with 21 additions and 1 deletion.
22 changes: 21 additions & 1 deletion api/ECNQueue.py
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,27 @@
# Classes
#------------------------------------------------------------------------------#
class Item:
# TODO: Add Item class documentation
"""A single issue.
Example:
# Create an Item (ce100)
>>> item = Item("ce", 100)
Attributes:
lastUpdated: An ISO 8601 formatted time string showing the last time the file was updated according to the filesystem.
headers: A list of dictionaries containing header keys and values.
content: A list of section dictionaries.
isLocked: A boolean showing whether or not a lockfile for the item is present.
userEmail: The email address of the person who this item is from.
userName: The real name of the person who this item is from.
userAlias: The Purdue career account alias of the person this item is from.
assignedTo: The Purdue career account alias of the person this item is assigned to
subject: The subject of the original message for this item.
status: The most recent status update for the item.
priority: The most recent priority for this item.
department: The most recent department for this item.
dateReceived: The date this item was created.
"""

def __init__(self, queue: str, number: int) -> None:

Expand Down

0 comments on commit a507ac7

Please sign in to comment.