Add module level docs

ECN · Oct 29, 2020 · 962a672 · 962a672
1 parent 51bb16f
commit 962a672
Showing 1 changed file with 9 additions and 1 deletion.
diff --git a/api/ECNQueue.py b/api/ECNQueue.py
@@ -1,4 +1,12 @@
-# TODO: Add ECNQueue module documentation
+"""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.
+
+Raises:
+	# TODO: Add description(s) of when a ValueError is raised.
+	ValueError: [description]
+"""
 
 #------------------------------------------------------------------------------#
 # Imports