]> granicus.if.org Git - python/commitdiff
Explain the 'result' argument in asyncio.sleep
authorEli Bendersky <eliben@gmail.com>
Mon, 20 Jan 2014 14:59:23 +0000 (06:59 -0800)
committerEli Bendersky <eliben@gmail.com>
Mon, 20 Jan 2014 14:59:23 +0000 (06:59 -0800)
Doc/library/asyncio-task.rst

index 43b506008cee15582e1571d6ba9d33b36a598c9f..e4abacd135afdf0cd0cb531d17b92e6828fc412d 100644 (file)
@@ -419,7 +419,8 @@ Task functions
 .. function:: sleep(delay, result=None, \*, loop=None)
 
    Create a :ref:`coroutine object <coroutine>` that completes after a given
-   time (in seconds).
+   time (in seconds).  If *result* is provided, it is produced to the caller
+   when the coroutine completes.
 
 .. function:: shield(arg, \*, loop=None)