clear run documentation

src/data/clear_run.py

@@ -5,8 +5,12 @@ from .processed import clear_run as clear_processed
 def clear_run(run):
     """Remove all derived data files (not raw).
 
-    Accepts glob expressions"""
-
+    Parameters
+    ----------
+    run : str
+        Name of the subfolder in data/interim and data/processed.
+        Accepts glob expressions.
+    """
     clear_interim(run)
     clear_processed(run)
 

src/data/interim/clear_run.py

@@ -10,6 +10,14 @@ curpath = get_path()
 
 
 def clear_run(run):
+    """Remove all derived data files from data/interim.
+
+    Parameters
+    ----------
+    run : str
+        Name of the subfolder in data/interim.
+        Accepts glob expressions.
+    """
     rmpath_glob = os.path.join(curpath, run)
     rmpaths = glob.glob(rmpath_glob)
     for path in rmpaths:

src/data/processed/clear_run.py

@@ -10,6 +10,14 @@ curpath = get_path()
 
 
 def clear_run(run):
+    """Remove all derived data files from data/processed.
+
+    Parameters
+    ----------
+    run : str
+        Name of the subfolder in data/processed.
+        Accepts glob expressions.
+    """
     rmpath_glob = os.path.join(curpath, run)
     rmpaths = glob.glob(rmpath_glob)
     for path in rmpaths: