More work to improve documentation generated by sphinx. Also fixes

[pyutils.git] / src / pyutils / parallelize / thread_utils.py

diff --git a/src/pyutils/parallelize/thread_utils.py b/src/pyutils/parallelize/thread_utils.py
index aaef13bf6ea8d53a788699f37c45f02bef47ccbf..e3747fd51231474d04e3d83f62c70b25ce2eb6e4 100644 (file)
--- a/src/pyutils/parallelize/thread_utils.py
+++ b/src/pyutils/parallelize/thread_utils.py
@@ -72,7 +72,11 @@ def background_thread(
 ) -> Callable[..., Tuple[threading.Thread, threading.Event]]:
     """A function decorator to create a background thread.
 
-    Usage::
+    Args:
+        _funct: The function being wrapped such that it is invoked
+            on a background thread.
+
+    Example usage::
 
         @background_thread
         def random(a: int, b: str, stop_event: threading.Event) -> None: