[Python-checkins] Update asyncio.ensure_future() documentation (GH-15347) (GH-15361)
Yury Selivanov
webhook-mailer at python.org
Wed Aug 21 13:01:58 EDT 2019
https://github.com/python/cpython/commit/fb3d7423f7ee4f6413774567d04b2f98b254e5f7
commit: fb3d7423f7ee4f6413774567d04b2f98b254e5f7
branch: 3.7
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: Yury Selivanov <yury at magic.io>
date: 2019-08-21T13:01:53-04:00
summary:
Update asyncio.ensure_future() documentation (GH-15347) (GH-15361)
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.
(cherry picked from commit 092911d5c0d8f6db8a0cb02fecd73dbb650f9e2e)
Co-authored-by: Roger Iyengar <ri at rogeriyengar.com>
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