Skip to content

Commit

Permalink
pythongh-101100: Fix Sphinx nits in library/contextlib.rst (python#…
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexWaygood authored and aisk committed Feb 11, 2024
1 parent 3ca4c27 commit c88d6e8
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 8 deletions.
14 changes: 7 additions & 7 deletions Doc/library/contextlib.rst
Original file line number Diff line number Diff line change
Expand Up @@ -106,8 +106,8 @@ Functions and classes provided:

This function is a :term:`decorator` that can be used to define a factory
function for :keyword:`async with` statement asynchronous context managers,
without needing to create a class or separate :meth:`__aenter__` and
:meth:`__aexit__` methods. It must be applied to an :term:`asynchronous
without needing to create a class or separate :meth:`~object.__aenter__` and
:meth:`~object.__aexit__` methods. It must be applied to an :term:`asynchronous
generator` function.

A simple example::
Expand Down Expand Up @@ -616,12 +616,12 @@ Functions and classes provided:
asynchronous context managers, as well as having coroutines for
cleanup logic.

The :meth:`close` method is not implemented, :meth:`aclose` must be used
The :meth:`~ExitStack.close` method is not implemented; :meth:`aclose` must be used
instead.

.. coroutinemethod:: enter_async_context(cm)

Similar to :meth:`enter_context` but expects an asynchronous context
Similar to :meth:`ExitStack.enter_context` but expects an asynchronous context
manager.

.. versionchanged:: 3.11
Expand All @@ -630,16 +630,16 @@ Functions and classes provided:

.. method:: push_async_exit(exit)

Similar to :meth:`push` but expects either an asynchronous context manager
Similar to :meth:`ExitStack.push` but expects either an asynchronous context manager
or a coroutine function.

.. method:: push_async_callback(callback, /, *args, **kwds)

Similar to :meth:`callback` but expects a coroutine function.
Similar to :meth:`ExitStack.callback` but expects a coroutine function.

.. coroutinemethod:: aclose()

Similar to :meth:`close` but properly handles awaitables.
Similar to :meth:`ExitStack.close` but properly handles awaitables.

Continuing the example for :func:`asynccontextmanager`::

Expand Down
1 change: 0 additions & 1 deletion Doc/tools/.nitignore
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,6 @@ Doc/library/collections.abc.rst
Doc/library/collections.rst
Doc/library/concurrent.futures.rst
Doc/library/configparser.rst
Doc/library/contextlib.rst
Doc/library/csv.rst
Doc/library/datetime.rst
Doc/library/dbm.rst
Expand Down

0 comments on commit c88d6e8

Please sign in to comment.