diff options
author | Nathaniel J. Smith <njs@pobox.com> | 2018-09-18 21:27:59 (GMT) |
---|---|---|
committer | Carol Willing <carolcode@willingconsulting.com> | 2018-09-18 21:27:59 (GMT) |
commit | a3c88ef12c7b8993912750b56a1e095652fe47c0 (patch) | |
tree | 13c1ffb44e0329dcaff8bf4e3590ec2d3346a411 /Doc | |
parent | 79d1c2e6c9d1bc1cf41ec3041801ca1a2b9a995b (diff) | |
download | cpython-a3c88ef12c7b8993912750b56a1e095652fe47c0.zip cpython-a3c88ef12c7b8993912750b56a1e095652fe47c0.tar.gz cpython-a3c88ef12c7b8993912750b56a1e095652fe47c0.tar.bz2 |
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.)
Diffstat (limited to 'Doc')
-rw-r--r-- | Doc/library/contextlib.rst | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/Doc/library/contextlib.rst b/Doc/library/contextlib.rst index 7dc5b29..930c973 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() |