Improve documentation for BaseRequest.path and BaseRequest.raw_path (#…

…3791)
aio-libs · May 22, 2019 · 6b0a651 · 6b0a651
1 parent 506c244
commit 6b0a651
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/CHANGES/3791.doc b/CHANGES/3791.doc
@@ -0,0 +1 @@
+Improve documentation for ``web.BaseRequest.path`` and ``web.BaseRequest.raw_path``.
diff --git a/docs/web_reference.rst b/docs/web_reference.rst
@@ -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.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Improve documentation for ``web.BaseRequest.path`` and ``web.BaseRequest.raw_path``.