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

Jump to bottom

[PR #7343/18057581 backport][3.8] Mention encoding in yarl.URL #7355

Merged
merged 1 commit into from
Jul 9, 2023
Merged

[PR #7343/18057581 backport][3.8] Mention encoding in yarl.URL #7355

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
12 changes: 9 additions & 3 deletions docs/client_reference.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -346,7 +346,9 @@ The client session supports the context manager protocol for self closing.

:param str method: HTTP method

:param url: Request URL, :class:`str` or :class:`~yarl.URL`.
:param url: Request URL, :class:`~yarl.URL` or :class:`str` that will
be encoded with :class:`~yarl.URL` (see :class:`~yarl.URL`
to skip encoding).

:param params: Mapping, iterable of tuple of *key*/*value* pairs or
string to be sent as parameters in the query
Expand Down Expand Up @@ -661,7 +663,9 @@ The client session supports the context manager protocol for self closing.
Create a websocket connection. Returns a
:class:`ClientWebSocketResponse` object.

:param url: Websocket server url, :class:`str` or :class:`~yarl.URL`
:param url: Websocket server url, :class:`~yarl.URL` or :class:`str` that
will be encoded with :class:`~yarl.URL` (see :class:`~yarl.URL`
to skip encoding).

:param tuple protocols: Websocket protocols

Expand Down Expand Up @@ -826,7 +830,9 @@ certification chaining.

:param str method: HTTP method

:param url: Requested URL, :class:`str` or :class:`~yarl.URL`
:param url: Request URL, :class:`~yarl.URL` or :class:`str` that will
be encoded with :class:`~yarl.URL` (see :class:`~yarl.URL`
to skip encoding).

:param dict params: Parameters to be sent in the query
string of the new request (optional)
Expand Down