diff options
| author | Roger Iyengar <ri@rogeriyengar.com> | 2019-08-21 15:59:11 (GMT) |
|---|---|---|
| committer | Yury Selivanov <yury@magic.io> | 2019-08-21 15:59:11 (GMT) |
| commit | 092911d5c0d8f6db8a0cb02fecd73dbb650f9e2e (patch) | |
| tree | bbe265d8e33013072c8038387e364f64d0b70f89 | |
| parent | 20f59fe1f7748ae899aceee4cb560e5e1f528a1f (diff) | |
| download | cpython-092911d5c0d8f6db8a0cb02fecd73dbb650f9e2e.zip cpython-092911d5c0d8f6db8a0cb02fecd73dbb650f9e2e.tar.gz cpython-092911d5c0d8f6db8a0cb02fecd73dbb650f9e2e.tar.bz2 | |
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.
| -rw-r--r-- | Doc/library/asyncio-future.rst | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/Doc/library/asyncio-future.rst b/Doc/library/asyncio-future.rst index 6e6e013..c069471 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.) |