diff --git a/api/ECNQueue.py b/api/ECNQueue.py index 8ae9a79..2c89889 100644 --- a/api/ECNQueue.py +++ b/api/ECNQueue.py @@ -1,7 +1,23 @@ -"""A library for interacting with Purdue ECN's Queue. - -This library allows for the creation of and interaction with individual issues called Items. -It also allows for the same with collections of Items called Queues. +"""A library for interacting with Purdue ECN's ticketing system. + +This library allows interacting with queue Items (called Items) and collections +of items (called Queues). + +Example: + # Create a single Item (ce100) + >>> item = Item("ce", 100) + # Get the sender's email address from an Item + >>> item = Item("ce", 100) + >>> item.userEmail + + # Create an entire Queue (ce) + >>> queue = Queue("ce") + # Get the number of items in a Queue + >>> queue = Queue("ce") + >>> numItems = len(queue) + + # Get all queues (and their items) + >>> queues = getQueues() Raises: # TODO: Add description(s) of when a ValueError is raised.