Add Queue doc block

ECN · Oct 29, 2020 · 4feaaad · 4feaaad
1 parent a507ac7
commit 4feaaad
Showing 1 changed file with 11 additions and 1 deletion.
diff --git 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