From 77002bb8fb2dc4daf48d1574888c50c032576268 Mon Sep 17 00:00:00 2001
From: Christian Michelsen <christianmichelsen@gmail.com>
Date: Thu, 18 Aug 2022 10:58:26 +0200
Subject: [PATCH] update docstring

---
 src/metaDMG/fit/serial.py | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/src/metaDMG/fit/serial.py b/src/metaDMG/fit/serial.py
index 5ef8c62..d08c256 100644
--- 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)