Преглед изворни кода

Update documentation of path_to_filesystem

Guillaume Ayoub пре 9 година
родитељ
комит
4fc5e3135a
1 измењених фајлова са 3 додато и 1 уклоњено
  1. 3 1
      radicale/storage.py

+ 3 - 1
radicale/storage.py

@@ -94,7 +94,9 @@ def is_safe_filesystem_path_component(path):
 def path_to_filesystem(root, *paths):
 def path_to_filesystem(root, *paths):
     """Convert path to a local filesystem path relative to base_folder.
     """Convert path to a local filesystem path relative to base_folder.
 
 
-    Conversion is done in a secure manner, or raises ``ValueError``.
+    `root` must be a secure filesystem path, it will be prepend to the path.
+
+    Conversion of `paths` is done in a secure manner, or raises ``ValueError``.
 
 
     """
     """
     paths = [sanitize_path(path).strip("/") for path in paths]
     paths = [sanitize_path(path).strip("/") for path in paths]