[Python-checkins] Update asyncio.ensure_future() documentation (GH-15347)
Yury Selivanov
webhook-mailer at python.org
Wed Aug 21 11:59:16 EDT 2019
https://github.com/python/cpython/commit/092911d5c0d8f6db8a0cb02fecd73dbb650f9e2e
commit: 092911d5c0d8f6db8a0cb02fecd73dbb650f9e2e
branch: master
author: Roger Iyengar <ri at rogeriyengar.com>
committer: Yury Selivanov <yury at magic.io>
date: 2019-08-21T11:59:11-04:00
summary:
Update asyncio.ensure_future() documentation (GH-15347)
Added back mention that ensure_future actually scheduled obj. This documentation just mentions what ensure_future returns, so I did not realize that ensure_future also schedules obj.
files:
M Doc/library/asyncio-future.rst
diff --git a/Doc/library/asyncio-future.rst b/Doc/library/asyncio-future.rst
index 6e6e0137c1bd..c069471b519b 100644
--- a/Doc/library/asyncio-future.rst
+++ b/Doc/library/asyncio-future.rst
@@ -35,7 +35,9 @@ Future Functions
is used for the test.)
* a :class:`Task` object wrapping *obj*, if *obj* is a
- coroutine (:func:`iscoroutine` is used for the test.)
+ coroutine (:func:`iscoroutine` is used for the test);
+ in this case the coroutine will be scheduled by
+ ``ensure_future()``.
* a :class:`Task` object that would await on *obj*, if *obj* is an
awaitable (:func:`inspect.isawaitable` is used for the test.)
More information about the Python-checkins
mailing list