orbit-oss/flask
4
4
Fork 2
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update helpers.send_from_directory docstring

Browse source 
Update helpers.send_from_directory docstring to match werkzeug.utils.send_from_directory docstring on the :param directory: line.

 The previous "relative to the current application's root path" is misleading to the actual behavior.
This commit is contained in:
David Carmichael 2024-09-07 12:07:41 +01:00
parent c77b099cbb
commit c98abb435e
1 changed files with 2 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

4
src/flask/helpers.py
View file

@ -546,8 +546,8 @@ def send_from_directory(
If the final path does not point to an existing regular file,
raises a 404 :exc:`~werkzeug.exceptions.NotFound` error.
:param directory: The directory that ``path`` must be located under,
relative to the current application's root path.
:param directory: The directory that ``path`` must be located under. This *must not*
be a value provided by the client, otherwise it becomes insecure.
:param path: The path to the file to send, relative to
``directory``.
:param kwargs: Arguments to pass to :func:`send_file`.