diff options
| author | Jonathan Villemaire-Krajden <odontomachus@gmail.com> | 2013-08-13 12:33:41 -0400 |
|---|---|---|
| committer | Jonathan Villemaire-Krajden <odontomachus@gmail.com> | 2013-08-13 12:33:41 -0400 |
| commit | e160a44cc459baf5e30ad19e18b7c95b0a6397ac (patch) | |
| tree | 894ecedf2b343c6e6d7af7ed3233c28ac53762e8 | |
| parent | fe8c0f5f2de669941015c222005be1b5e62e39ed (diff) | |
| download | pyramid-e160a44cc459baf5e30ad19e18b7c95b0a6397ac.tar.gz pyramid-e160a44cc459baf5e30ad19e18b7c95b0a6397ac.tar.bz2 pyramid-e160a44cc459baf5e30ad19e18b7c95b0a6397ac.zip | |
Updated doc string for Request.current_route_url.
| -rw-r--r-- | pyramid/url.py | 19 |
1 files changed, 11 insertions, 8 deletions
diff --git a/pyramid/url.py b/pyramid/url.py index feb304fb8..b135c361a 100644 --- a/pyramid/url.py +++ b/pyramid/url.py @@ -124,15 +124,18 @@ class URLMethodsMixin(object): ``*remainder`` replacement value, it is tacked on to the URL after being URL-quoted-except-for-embedded-slashes. - If a keyword argument ``_query`` is present, it will be used to - compose a query string that will be tacked on to the end of the - URL. The value of ``_query`` must be a sequence of two-tuples - *or* a data structure with an ``.items()`` method that returns a + If no ``_query`` keyword argument is provided, the request + query string will be returned in the URL. If it is present, it + will be used to compose a query string that will be tacked on + to the end of the URL, replacing any request query string. + The value of ``_query`` must be a sequence of two-tuples *or* + a data structure with an ``.items()`` method that returns a sequence of two-tuples (presumably a dictionary). This data - structure will be turned into a query string per the documentation - of :func:`pyramid.encode.urlencode` function. After the query - data is turned into a query string, a leading ``?`` is prepended, - and the resulting string is appended to the generated URL. + structure will be turned into a query string per the + documentation of :func:`pyramid.encode.urlencode` function. + After the query data is turned into a query string, a leading + ``?`` is prepended, and the resulting string is appended to + the generated URL. .. note:: |
