Add doctests to some of this stuff.

[python_utils.git] / thread_utils.py

diff --git a/thread_utils.py b/thread_utils.py
index bb15c034b9e4e02f273b98dbc77410072878e089..0130cdc510547196d418d6699d1b46b84a6ddf7c 100644 (file)
--- a/thread_utils.py
+++ b/thread_utils.py
@@ -20,6 +20,9 @@ def current_thread_id() -> str:
 
 
 def is_current_thread_main_thread() -> bool:
+    """Returns True is the current (calling) thread is the process' main
+    thread and False otherwise.
+    """
     return threading.current_thread() is threading.main_thread()