From: Victor Stinner <victor.stinner@gmail.com>
Date: Sun, 12 Oct 2014 19:36:17 +0000 (+0200)
Subject: asyncio doc: more explicit doc for async()
X-Git-Tag: v3.5.0a1~676^2~1
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=980dd84f92f689f810ebf10a15f221c8d396ce4e;p=python

asyncio doc: more explicit doc for async()

The function schedules the execution of coroutines, it's not just a wrapper for
something.
---

diff --git a/Doc/library/asyncio-task.rst b/Doc/library/asyncio-task.rst
index 8c4d790eac..fa95ca9804 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.