docs: Add docstring to workflow function

metaDMG-dev · Aug 18, 2022 · 2ee4c6b · 2ee4c6b
1 parent eeec366
commit 2ee4c6b
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/src/metaDMG/fit/workflow.py b/src/metaDMG/fit/workflow.py
@@ -10,6 +10,17 @@
 
 
 def run_workflow(configs: Configs) -> int:
+    """Runs the entire metaDMG workflow.
+
+    Parameters
+    ----------
+    configs
+        A Configs object containing the configuration parameters for the workflow.
+
+    Returns
+    -------
+        _description_
+    """
 
     parallel_samples = min(configs["parallel_samples"], len(configs))