From: Nathaniel J. Smith <njs@pobox.com>
Date: Tue, 18 Sep 2018 21:27:59 +0000 (-0700)
Subject: Clarify that AsyncExitStack works with coroutine functions (GH-9405)
X-Git-Tag: v3.8.0a1~942
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=a3c88ef12c7b8993912750b56a1e095652fe47c0;p=python

Clarify that AsyncExitStack works with coroutine functions (GH-9405)

The docs were ambiguous about whether you pass in a coroutine function
or a coroutine object, e.g. is it:

  aestack.push_async_exit(some_async_func)

or

  aestack.push_async_exit(some_async_func())

(It's the first one.)
---

diff --git a/Doc/library/contextlib.rst b/Doc/library/contextlib.rst
index 7dc5b2989f..930c97358e 100644
--- a/Doc/library/contextlib.rst
+++ b/Doc/library/contextlib.rst
@@ -471,11 +471,11 @@ Functions and classes provided:
    .. method:: push_async_exit(exit)
 
       Similar to :meth:`push` but expects either an asynchronous context manager
-      or a coroutine.
+      or a coroutine function.
 
    .. method:: push_async_callback(callback, *args, **kwds)
 
-      Similar to :meth:`callback` but expects a coroutine.
+      Similar to :meth:`callback` but expects a coroutine function.
 
    .. method:: aclose()