Skip to content

Commit dd8e24e

Browse files
[PR #7343/18057581 backport][3.8] Mention encoding in yarl.URL (#7355)
Co-authored-by: Sam Bull <[email protected]>
1 parent 4087410 commit dd8e24e

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

docs/client_reference.rst

+9-3
Original file line numberDiff line numberDiff line change
@@ -346,7 +346,9 @@ The client session supports the context manager protocol for self closing.
346346

347347
:param str method: HTTP method
348348

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

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

664-
:param url: Websocket server url, :class:`str` or :class:`~yarl.URL`
666+
:param url: Websocket server url, :class:`~yarl.URL` or :class:`str` that
667+
will be encoded with :class:`~yarl.URL` (see :class:`~yarl.URL`
668+
to skip encoding).
665669

666670
:param tuple protocols: Websocket protocols
667671

@@ -826,7 +830,9 @@ certification chaining.
826830

827831
:param str method: HTTP method
828832

829-
:param url: Requested URL, :class:`str` or :class:`~yarl.URL`
833+
:param url: Request URL, :class:`~yarl.URL` or :class:`str` that will
834+
be encoded with :class:`~yarl.URL` (see :class:`~yarl.URL`
835+
to skip encoding).
830836

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

0 commit comments

Comments
 (0)