chore: comment import init logs

lucas-nelson-uiuc · Dec 26, 2024 · 4bcb94c · 4bcb94c
1 parent c1ce420
commit 4bcb94c
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/tidy_tools/__init__.py b/src/tidy_tools/__init__.py
@@ -6,6 +6,10 @@
 __version__ = "0.3.1"
 
 
+# upon import:
+#   - remove existing logger
+#   - update logging format
+#   - log welcome message for documentation
 LOG_FORMAT: str = "{time:HH:mm:ss} | <level>{level:<8}</level> | {message}"
 logger.remove()
 logger.add(sys.stderr, format=LOG_FORMAT)