update docstring

metaDMG-dev · Aug 18, 2022 · 77002bb · 77002bb
1 parent 9e065aa
commit 77002bb
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/src/metaDMG/fit/serial.py b/src/metaDMG/fit/serial.py
@@ -551,6 +551,17 @@ def run_single_config(
 def run_single_config_count_errors(
     config: Config,
 ) -> int:
+    """Allows for using pool.map() (multiprocessing) while also counting the errors.
+
+    Parameters
+    ----------
+    config
+        A config file.
+
+    Returns
+    -------
+        0 if no error, 1 if error
+    """
 
     try:
         run_single_config(config)