More work to improve documentation generated by sphinx. Also fixes

[pyutils.git] / src / pyutils / function_utils.py

diff --git a/src/pyutils/function_utils.py b/src/pyutils/function_utils.py
index a8ab0c74cfc50cb53b1e5b1b3f4dc49a8c9fc51e..f4202d38ce03bf97bb837044fbfa01ec4d06160a 100644 (file)
--- a/src/pyutils/function_utils.py
+++ b/src/pyutils/function_utils.py
@@ -9,15 +9,23 @@ from typing import Callable
 
 def function_identifier(f: Callable) -> str:
     """
-    Given a callable function, return a string that identifies it.
-    Usually that string is just __module__:__name__ but there's a
+    Given a named `Callable`, return a string that identifies it.
+    Usually that string is just "__module__:__name__" but there's a
     corner case: when __module__ is __main__ (i.e. the callable is
     defined in the same module as __main__).  In this case,
     f.__module__ returns "__main__" instead of the file that it is
-    defined in.  Work around this using pathlib.Path (see below).
+    defined in.  Work around this using `pathlib.Path`.
+
+    Args:
+        f: a Callable
+
+    Returns:
+        A unique identifier for that callable in the format
+        module:function that avoids the pseudo-module '__main__'
 
     >>> function_identifier(function_identifier)
     'function_utils:function_identifier'
+
     """
 
     if f.__module__ == '__main__':
@@ -30,3 +38,9 @@ def function_identifier(f: Callable) -> str:
         return f'{module}:{f.__name__}'
     else:
         return f'{f.__module__}:{f.__name__}'
+
+
+if __name__ == '__main__':
+    import doctest
+
+    doctest.testmod()