diff options
| author | Victor Stinner <victor.stinner@gmail.com> | 2014-10-12 19:36:17 (GMT) |
|---|---|---|
| committer | Victor Stinner <victor.stinner@gmail.com> | 2014-10-12 19:36:17 (GMT) |
| commit | 980dd84f92f689f810ebf10a15f221c8d396ce4e (patch) | |
| tree | 8e7926dfd6aaff888e069375d4baaa80a5d4f048 | |
| parent | 33f6abe4ae7b1fa6d83e26c4dafc0210c09d2254 (diff) | |
| download | cpython-980dd84f92f689f810ebf10a15f221c8d396ce4e.zip cpython-980dd84f92f689f810ebf10a15f221c8d396ce4e.tar.gz cpython-980dd84f92f689f810ebf10a15f221c8d396ce4e.tar.bz2 | |
asyncio doc: more explicit doc for async()
The function schedules the execution of coroutines, it's not just a wrapper for
something.
| -rw-r--r-- | Doc/library/asyncio-task.rst | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/Doc/library/asyncio-task.rst b/Doc/library/asyncio-task.rst index 8c4d790..fa95ca9 100644 --- a/Doc/library/asyncio-task.rst +++ b/Doc/library/asyncio-task.rst @@ -478,7 +478,8 @@ Task functions .. function:: async(coro_or_future, \*, loop=None) - Wrap a :ref:`coroutine object <coroutine>` in a future. + Schedule the execution of a :ref:`coroutine object <coroutine>`: wrap it in + a future. Return a :class:`Task` object. If the argument is a :class:`Future`, it is returned directly. |