Skip to content

Commit 7ae1c5a

Browse files
committed
Merge pull request pallets#1325 from bsutherland/rqst_properteis_doc_iri_patch
Clarify contents of request properties.
2 parents 94a3968 + 0d86a89 commit 7ae1c5a

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

docs/api.rst

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -92,25 +92,26 @@ Incoming Request Data
9292
.. attribute:: base_url
9393
.. attribute:: url_root
9494

95-
Provides different ways to look at the current URL. Imagine your
96-
application is listening on the following URL::
95+
Provides different ways to look at the current
96+
`IRI<http://tools.ietf.org/html/rfc3987>`_. Imagine your
97+
application is listening on the following application root::
9798

9899
http://www.example.com/myapplication
99100

100-
And a user requests the following URL::
101+
And a user requests the following URI::
101102

102-
http://www.example.com/myapplication/page.html?x=y
103+
http://www.example.com/myapplication/%CF%80/page.html?x=y
103104

104105
In this case the values of the above mentioned attributes would be
105106
the following:
106107

107108
============= ======================================================
108-
`path` ``/page.html``
109-
`full_path` ``/page.html?x=y``
110-
`script_root` ``/myapplication``
111-
`base_url` ``http://www.example.com/myapplication/page.html``
112-
`url` ``http://www.example.com/myapplication/page.html?x=y``
113-
`url_root` ``http://www.example.com/myapplication/``
109+
`path` ``u'/π/page.html'``
110+
`full_path` ``u'/π/page.html?x=y'``
111+
`script_root` ``u'/myapplication'``
112+
`base_url` ``u'http://www.example.com/myapplication/π/page.html'``
113+
`url` ``u'http://www.example.com/myapplication/π/page.html?x=y'``
114+
`url_root` ``u'http://www.example.com/myapplication/'``
114115
============= ======================================================
115116

116117
.. attribute:: is_xhr

0 commit comments

Comments
 (0)