From 4fc5e3135a7fa08e5d6b398e94055f07a19926a0 Mon Sep 17 00:00:00 2001 From: Guillaume Ayoub Date: Tue, 24 May 2016 14:39:41 +0200 Subject: [PATCH] Update documentation of path_to_filesystem --- radicale/storage.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/radicale/storage.py b/radicale/storage.py index a6f744f..d68431e 100644 --- a/radicale/storage.py +++ b/radicale/storage.py @@ -94,7 +94,9 @@ def is_safe_filesystem_path_component(path): def path_to_filesystem(root, *paths): """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]