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.

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

Correct a spelling mistake in quickstart: "canonize"->"canonicalize" #4986

Merged
merged 1 commit into from
Oct 1, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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/4986.doc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Spelling: Change "canonize" to "canonicalize".
8 changes: 4 additions & 4 deletions docs/client_quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -115,18 +115,18 @@ is not encoded by library. Note that ``+`` is not encoded::

.. note::

*aiohttp* internally performs URL canonization before sending request.
*aiohttp* internally performs URL canonicalization before sending request.

Canonization encodes *host* part by :term:`IDNA` codec and applies
Canonicalization encodes *host* part by :term:`IDNA` codec and applies
:term:`requoting` to *path* and *query* parts.

For example ``URL('http://example.com/путь/%30?a=%31')`` is converted to
``URL('http://example.com/%D0%BF%D1%83%D1%82%D1%8C/0?a=1')``.

Sometimes canonization is not desirable if server accepts exact
Sometimes canonicalization is not desirable if server accepts exact
representation and does not requote URL itself.

To disable canonization use ``encoded=True`` parameter for URL construction::
To disable canonicalization use ``encoded=True`` parameter for URL construction::

await session.get(
URL('http://example.com/%30', encoded=True))
Expand Down