add args docs

JOJ0 · Jan 29, 2025 · eaaa465 · eaaa465
1 parent 6c42c8b
commit eaaa465
Showing 1 changed file with 8 additions and 1 deletion.
diff --git a/synadm/api.py b/synadm/api.py
@@ -41,7 +41,14 @@
 
 
 def log_fatal_exit(error, logger, message=None):
-    """Log a fatal error and exit synadm."""
+    """Log a fatal error and exit synadm.
+
+    Args:
+        error: A Python exception.
+        logger: A Python logger, with info and fatal methods
+        message: Message to use instead of "synadm exited due to a fatal
+            error."
+    """
     if message is None:
         message = "synadm exited due to a fatal error."