summaryrefslogtreecommitdiffstats
path: root/Doc/library/contextlib.rst
diff options
context:
space:
mode:
authorAlex Waygood <Alex.Waygood@Gmail.com>2023-12-08 13:17:57 (GMT)
committerGitHub <noreply@github.com>2023-12-08 13:17:57 (GMT)
commite4c087603397a1314253b861d35f8314fba8ae92 (patch)
tree783c7e81ee29fe2b5a3f870bb96b5f022a352eea /Doc/library/contextlib.rst
parent3cdcc2edf81c7be4c88d4f273947ce29f916f49a (diff)
downloadcpython-e4c087603397a1314253b861d35f8314fba8ae92.zip
cpython-e4c087603397a1314253b861d35f8314fba8ae92.tar.gz
cpython-e4c087603397a1314253b861d35f8314fba8ae92.tar.bz2
gh-101100: Fix Sphinx nits in `library/contextlib.rst` (#112870)
Diffstat (limited to 'Doc/library/contextlib.rst')
-rw-r--r--Doc/library/contextlib.rst14
1 files changed, 7 insertions, 7 deletions
diff --git a/Doc/library/contextlib.rst b/Doc/library/contextlib.rst
index f6ebbfa..aab319c 100644
--- a/Doc/library/contextlib.rst
+++ b/Doc/library/contextlib.rst
@@ -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::
@@ -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
@@ -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`::