]> granicus.if.org Git - python/commitdiff
asyncio doc: more explicit doc for async()
authorVictor Stinner <victor.stinner@gmail.com>
Sun, 12 Oct 2014 19:36:17 +0000 (21:36 +0200)
committerVictor Stinner <victor.stinner@gmail.com>
Sun, 12 Oct 2014 19:36:17 +0000 (21:36 +0200)
The function schedules the execution of coroutines, it's not just a wrapper for
something.

Doc/library/asyncio-task.rst

index 8c4d790eace7fbeebb59ee95524188cf5535c944..fa95ca980401b236df01912ba3256af9e66286de 100644 (file)
@@ -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.