Update documentation of path_to_filesystem

This commit is contained in:
Guillaume Ayoub 2016-05-24 14:39:41 +02:00
parent ac687c6179
commit 4fc5e3135a

View File

@ -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]