Mod: Update docstring.

Labbeti · Nov 23, 2023 · 6611aa1 · 6611aa1
1 parent 1b772b5
commit 6611aa1
Showing 1 changed file with 3 additions and 3 deletions.
diff --git a/src/aac_datasets/utils/download.py b/src/aac_datasets/utils/download.py
@@ -13,15 +13,15 @@
 
 
 def safe_rmdir(
-    root: str,
+    root: Union[str, Path],
     rm_root: bool = True,
     error_on_non_empty_dir: bool = True,
 ) -> List[str]:
     """Remove all empty sub-directories.
 
     :param root: Root directory path.
-    :param rm_root: If True, remove the root directory. defaults to True.
-    :param error_on_non_empty_dir: If True, raises a RuntimeError if a subdirectory contains 1 file.
+    :param rm_root: If True, remove the root directory too. defaults to True.
+    :param error_on_non_empty_dir: If True, raises a RuntimeError if a subdirectory contains at least 1 file. Otherwise it will leave non-empty directories. defaults to True.
     :returns: The list of directories paths deleted.
     """
     deleted = []