maya-chen/flask
1
0
Fork 0
forked from orbit-oss/flask
Code Pull requests Activity

Merge pull request #1144 from untitaker/url_for_scheme_docs

Browse source 
Add documentation about url_for's default scheme
This commit is contained in:
Kenneth Reitz 2014-08-12 14:46:56 -04:00
commit 60260eb0f0
1 changed files with 4 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

5
flask/helpers.py
View file

@ -248,7 +248,10 @@ def url_for(endpoint, **values):
address can be changed via `SERVER_NAME` configuration variable which
defaults to `localhost`.
:param _scheme: a string specifying the desired URL scheme. The `_external`
parameter must be set to `True` or a `ValueError` is raised.
parameter must be set to `True` or a `ValueError` is raised. The default
behavior uses the same scheme as the current request, or
``PREFERRED_URL_SCHEME`` from the :ref:`app configuration <config>` if no
request context is available.
:param _anchor: if provided this is added as anchor to the URL.
:param _method: if provided this explicitly specifies an HTTP method.
"""