]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[3.11] gh-101100: Fix Sphinx nits in `library/contextlib.rst` (#112870) (#112874)
authorAlex Waygood <Alex.Waygood@Gmail.com>
Fri, 8 Dec 2023 14:03:15 +0000 (14:03 +0000)
committerGitHub <noreply@github.com>
Fri, 8 Dec 2023 14:03:15 +0000 (14:03 +0000)
(cherry-picked from commit e4c087603397a1314253b861d35f8314fba8ae92)

Doc/library/contextlib.rst
Doc/tools/.nitignore

index 80a683d4756fe822e08c3deb5c40d203106b70df..c01112a0a85895046ab98ef3edd19901e2285bd2 100644 (file)
@@ -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::
@@ -609,12 +609,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
@@ -623,16 +623,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`::
 
index 68fd9810b3929e779a9ea8bdf452d1064cd293cd..3a9d182479b9867f0e8cec7f33dd566b87a9a203 100644 (file)
@@ -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/copy.rst
 Doc/library/csv.rst
 Doc/library/ctypes.rst