Skip to content

Commit

Permalink
pythongh-101100: Fix reference to asynchronous methods (pythonGH-106172)
Browse files Browse the repository at this point in the history
(cherry picked from commit bbf722d)

Co-authored-by: F3eQnxN3RriK <drsuaimqjgar@gmail.com>
  • Loading branch information
F3eQnxN3RriK authored and miss-islington committed Jun 28, 2023
1 parent 966e0f6 commit b32a752
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
18 changes: 9 additions & 9 deletions Doc/glossary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -92,8 +92,8 @@ Glossary

asynchronous context manager
An object which controls the environment seen in an
:keyword:`async with` statement by defining :meth:`__aenter__` and
:meth:`__aexit__` methods. Introduced by :pep:`492`.
:keyword:`async with` statement by defining :meth:`~object.__aenter__` and
:meth:`~object.__aexit__` methods. Introduced by :pep:`492`.

asynchronous generator
A function which returns an :term:`asynchronous generator iterator`. It
Expand All @@ -113,26 +113,26 @@ Glossary
An object created by a :term:`asynchronous generator` function.

This is an :term:`asynchronous iterator` which when called using the
:meth:`__anext__` method returns an awaitable object which will execute
:meth:`~object.__anext__` method returns an awaitable object which will execute
the body of the asynchronous generator function until the next
:keyword:`yield` expression.

Each :keyword:`yield` temporarily suspends processing, remembering the
location execution state (including local variables and pending
try-statements). When the *asynchronous generator iterator* effectively
resumes with another awaitable returned by :meth:`__anext__`, it
resumes with another awaitable returned by :meth:`~object.__anext__`, it
picks up where it left off. See :pep:`492` and :pep:`525`.

asynchronous iterable
An object, that can be used in an :keyword:`async for` statement.
Must return an :term:`asynchronous iterator` from its
:meth:`__aiter__` method. Introduced by :pep:`492`.
:meth:`~object.__aiter__` method. Introduced by :pep:`492`.

asynchronous iterator
An object that implements the :meth:`__aiter__` and :meth:`__anext__`
methods. ``__anext__`` must return an :term:`awaitable` object.
An object that implements the :meth:`~object.__aiter__` and :meth:`~object.__anext__`
methods. :meth:`~object.__anext__` must return an :term:`awaitable` object.
:keyword:`async for` resolves the awaitables returned by an asynchronous
iterator's :meth:`__anext__` method until it raises a
iterator's :meth:`~object.__anext__` method until it raises a
:exc:`StopAsyncIteration` exception. Introduced by :pep:`492`.

attribute
Expand All @@ -149,7 +149,7 @@ Glossary

awaitable
An object that can be used in an :keyword:`await` expression. Can be
a :term:`coroutine` or an object with an :meth:`__await__` method.
a :term:`coroutine` or an object with an :meth:`~object.__await__` method.
See also :pep:`492`.

BDFL
Expand Down
2 changes: 1 addition & 1 deletion Doc/library/exceptions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -450,7 +450,7 @@ The following exceptions are the exceptions that are usually raised.

.. exception:: StopAsyncIteration

Must be raised by :meth:`__anext__` method of an
Must be raised by :meth:`~object.__anext__` method of an
:term:`asynchronous iterator` object to stop the iteration.

.. versionadded:: 3.5
Expand Down

0 comments on commit b32a752

Please sign in to comment.