X-Git-Url: https://wannabe.guru.org/gitweb/?a=blobdiff_plain;f=src%2Fpyutils%2Fparallelize%2Fthread_utils.py;h=e3747fd51231474d04e3d83f62c70b25ce2eb6e4;hb=993b0992473c12294ed659e52b532e1c8cf9cd1e;hp=aaef13bf6ea8d53a788699f37c45f02bef47ccbf;hpb=b38920f24d1ac948958480c540bc4b8436186765;p=pyutils.git

diff --git a/src/pyutils/parallelize/thread_utils.py b/src/pyutils/parallelize/thread_utils.py
index aaef13b..e3747fd 100644
--- 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: