From 4feaaada3d56709da58af5ac37df75777510c1f6 Mon Sep 17 00:00:00 2001 From: Justin Campbell Date: Thu, 29 Oct 2020 14:57:30 -0400 Subject: [PATCH] Add Queue doc block --- api/ECNQueue.py | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/api/ECNQueue.py b/api/ECNQueue.py index 43ad0f0..beab098 100644 --- a/api/ECNQueue.py +++ b/api/ECNQueue.py @@ -1174,7 +1174,17 @@ def __repr__(self) -> str: return self.queue + str(self.number) class Queue: - # TODO: Add Queue class documentation + """A collection of items. + + Example: + # Create a queue (ce) + >>> queue = Queue("ce") + + Attributes: + name: The name of the queue. + items: A list of Items in the queue. + jsonData: A JSON serializable representation of the Queue. + """ def __init__(self, name: str) -> None: self.name = name