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

Minor fixes to docs #7567

Draft
wants to merge 5 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions docs/client_advanced.rst
Original file line number Diff line number Diff line change
Expand Up @@ -700,7 +700,7 @@ Graceful Shutdown
-----------------

When :class:`ClientSession` closes at the end of an ``async with``
block (or through a direct :meth:`ClientSession.close()` call), the
block (or through a direct :meth:`ClientSession.close` call), the
underlying connection remains open due to asyncio internal details. In
practice, the underlying connection will close after a short
while. However, if the event loop is stopped before the underlying
Expand Down Expand Up @@ -745,7 +745,7 @@ aiohttp does not support HTTP/HTTPS pipelining.
Character Set Detection
-----------------------

If you encounter a :exc:`UnicodeDecodeError` when using :meth:`ClientResponse.text()`
If you encounter a :exc:`UnicodeDecodeError` when using :meth:`ClientResponse.text`
this may be because the response does not include the charset needed
to decode the body.

Expand Down
10 changes: 5 additions & 5 deletions docs/client_reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ The client session supports the context manager protocol for self closing.

:param bool raise_for_status:

Automatically call :meth:`ClientResponse.raise_for_status()` for
Automatically call :meth:`ClientResponse.raise_for_status` for
each response, ``False`` by default.

This parameter can be overridden when you making a request, e.g.::
Expand Down Expand Up @@ -211,7 +211,7 @@ The client session supports the context manager protocol for self closing.
disabling. See :ref:`aiohttp-client-tracing-reference` for
more information.

:param Callable[[ClientResponse,bytes],str] fallback_charset_resolver:
:param fallback_charset_resolver: Callable[[ClientResponse, bytes], str]
A :term:`callable` that accepts a :class:`ClientResponse` and the
:class:`bytes` contents, and returns a :class:`str` which will be used as
the encoding parameter to :meth:`bytes.decode()`.
Expand Down Expand Up @@ -317,7 +317,7 @@ The client session supports the context manager protocol for self closing.

.. attribute:: raise_for_status

Should :meth:`ClientResponse.raise_for_status()` be called for each response
Should :meth:`ClientResponse.raise_for_status` be called for each response

Either :class:`bool` or :class:`collections.abc.Callable`

Expand Down Expand Up @@ -443,7 +443,7 @@ The client session supports the context manager protocol for self closing.
:param bool expect100: Expect 100-continue response from server.
``False`` by default (optional).

:param bool raise_for_status: Automatically call :meth:`ClientResponse.raise_for_status()` for
:param bool raise_for_status: Automatically call :meth:`ClientResponse.raise_for_status` for
response if set to ``True``.
If set to ``None`` value from ``ClientSession`` will be used.
``None`` by default (optional).
Expand Down Expand Up @@ -897,7 +897,7 @@ certification chaining.
``False`` by default (optional).

:param bool raise_for_status: Automatically call
:meth:`ClientResponse.raise_for_status()`
:meth:`ClientResponse.raise_for_status`
for response if set to ``True``. If
set to ``None`` value from
``ClientSession`` will be used.
Expand Down
4 changes: 2 additions & 2 deletions docs/streams.rst
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ Helpers

.. seealso::

:meth:`StreamReader.at_eof()`
:meth:`StreamReader.at_eof`

.. method:: StreamReader.at_eof()

Expand All @@ -196,7 +196,7 @@ Helpers

.. warning:: The method does not wake up waiters.

E.g. :meth:`~StreamReader.read()` will not be resumed.
E.g. :meth:`~StreamReader.read` will not be resumed.


.. method:: wait_eof()
Expand Down
6 changes: 3 additions & 3 deletions docs/web_reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -956,8 +956,8 @@ and :ref:`aiohttp-web-signals` handlers::
:meth:`receive` and others.

To enable back-pressure from slow websocket clients treat methods
:meth:`ping()`, :meth:`pong()`, :meth:`send_str()`,
:meth:`send_bytes()`, :meth:`send_json()` as coroutines. By
:meth:`ping`, :meth:`pong`, :meth:`send_str`,
:meth:`send_bytes`, :meth:`send_json` as coroutines. By
default write buffer size is set to 64k.

:param bool autoping: Automatically send
Expand Down Expand Up @@ -1535,7 +1535,7 @@ Application and Router
:async:

A :ref:`coroutine<coroutine>` that should be called on
server stopping but before :meth:`cleanup()`.
server stopping but before :meth:`cleanup`.

The purpose of the method is calling :attr:`on_shutdown` signal
handlers.
Expand Down