Since this thing is on the innerwebs I suppose it should have a

[python_utils.git] / exceptions.py

diff --git a/exceptions.py b/exceptions.py
index 3e0a2d080b56742d71d1d02ee45ac13fd8d5a146..bd499886221ba55e044a739e835fdc4af8c98c6e 100644 (file)
--- a/exceptions.py
+++ b/exceptions.py
@@ -1,15 +1,30 @@
 #!/usr/bin/env python3
 
+# © Copyright 2021-2022, Scott Gasch
+
+"""Some exceptions used elsewhere."""
+
+# This module is commonly used by others in here and should avoid
+# taking any unnecessary dependencies back on them.
+
+
 class PreconditionException(AssertionError):
+    """Use to indicate function preconditions violated."""
+
     pass
 
 
 class PostconditionException(AssertionError):
+    """Use to indicate function postconditions violated."""
+
     pass
 
 
 class TimeoutError(Exception):
+    """Use to indicate an operation that timed out."""
+
     def __init__(self, value: str = "Timed out"):
+        super().__init__()
         self.value = value
 
     def __str__(self):