docs: minor docstring fixes

okunator · okunator · commit f30991b54e3e · 2023-01-13T18:02:45.000+02:00
diff --git a/cellseg_models_pytorch/utils/multiproc.py b/cellseg_models_pytorch/utils/multiproc.py
@@ -66,6 +66,12 @@ def run_pool(
     -------
         Union[List[Any], None]:
             A list of results or None.
+
+    Example
+    -------
+        >>> f = myfunc # any function.
+        >>> args = (1, 2, 3)
+        >>> res_list = run_pool(f, args)
     """
     allowed = ("process", "thread", "serial")
     if pooltype not in allowed:
