Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve documentation for BaseRequest.path and BaseRequest.raw_path #3791

Merged
merged 3 commits into from
May 22, 2019
Merged

Improve documentation for BaseRequest.path and BaseRequest.raw_path #3791

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8e7d654
Fix grammar in documentation for BaseRequest.raw_path
Harmon758 May 22, 2019
8cd2300
Change "quoted" to "URL-encoded" in BaseRequest documentation
Harmon758 May 22, 2019
fe4b9dd
Add news fragment
Harmon758 May 22, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGES/3791.doc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Improve documentation for ``web.BaseRequest.path`` and ``web.BaseRequest.raw_path``.
6 changes: 3 additions & 3 deletions docs/web_reference.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,19 +161,19 @@ and :ref:`aiohttp-web-signals` handlers.
.. attribute:: path

The URL including *PATH INFO* without the host or scheme. e.g.,
``/app/blog``. The path is URL-unquoted. For raw path info see
``/app/blog``. The path is URL-decoded. For raw path info see
:attr:`raw_path`.

Read-only :class:`str` property.

.. attribute:: raw_path

The URL including raw *PATH INFO* without the host or scheme.
Warning, the path may be quoted and may contains non valid URL
Warning, the path may be URL-encoded and may contain invalid URL
characters, e.g.
``/my%2Fpath%7Cwith%21some%25strange%24characters``.

For unquoted version please take a look on :attr:`path`.
For URL-decoded version please take a look on :attr:`path`.

Read-only :class:`str` property.

Expand Down