Skip to content

Commit

Permalink
Mention encoding in yarl.URL (#7343)
Browse files Browse the repository at this point in the history
Ref #7341

(cherry picked from commit 1805758)
  • Loading branch information
Dreamsorcerer authored and patchback[bot] committed Jul 9, 2023
1 parent 4087410 commit 75d223a
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions docs/client_reference.rst
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

0 comments on commit 75d223a

Please sign in to comment.