Add file docstrings to every .py file, improved exception docstrings, helper func typehint

2025-12-10 18:09:05 -06:00 · 2021-01-24 23:30:09 -06:00
parent 58884a43ff
commit c9fad55ade
10 changed files with 73 additions and 11 deletions
--- a/main.py
+++ b/main.py
@@ -1,3 +1,10 @@
+"""
+main.py
+
+The main launcher file for running the bot. Run python against the file, and specify the channel ID and the bot ID
+to be checked against. Also sets up logging for the rest of the project, and runs the client.
+"""
+
 import argparse
 import logging