Skip to content

Commit

Permalink
Update module docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Justin Campbell committed Oct 29, 2020
1 parent d0f9bc6 commit 0c28cfe
Showing 1 changed file with 20 additions and 4 deletions.
24 changes: 20 additions & 4 deletions api/ECNQueue.py
Original file line number Diff line number Diff line change
@@ -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.
Expand Down

0 comments on commit 0c28cfe

Please sign in to comment.