From eaaa465ee0509337e06196499260adc85f2b7b89 Mon Sep 17 00:00:00 2001
From: Jackson <jackson@jacksonchen666.com>
Date: Wed, 29 Jan 2025 17:26:56 +0100
Subject: [PATCH] add args docs

---
 synadm/api.py | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

diff --git a/synadm/api.py b/synadm/api.py
index e6128e3..0c1d40b 100644
--- 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."