Add docstring for dir_size

uwefladrich · Apr 18, 2022 · faad94b · faad94b
1 parent a6c1047
commit faad94b
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/monitoring/diskusage_rte_scalar.py b/monitoring/diskusage_rte_scalar.py
@@ -7,6 +7,9 @@
 
 
 def _dir_size(dir):
+    """Counts (recursively) the size of all files stored in a directory and
+    returns the sum (size in bytes). Note that all files and (sub)directories
+    that are not readable (i.e. due to missing permissions) are ignored."""
     if not dir.exists():
         raise FileNotFoundError
     if not dir.is_dir():