From 962a672cb8e085ea490fb7011572ab1a79784e9a Mon Sep 17 00:00:00 2001 From: Justin Campbell Date: Thu, 29 Oct 2020 14:27:10 -0400 Subject: [PATCH] Add module level docs --- api/ECNQueue.py | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/api/ECNQueue.py b/api/ECNQueue.py index 7c2ae1d..901bc92 100644 --- 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