Explain the 'result' argument in asyncio.sleep

2014-01-20 06:59:23 -08:00 · 2014-01-20 06:59:23 -08:00 · 2d26af82c1
parent 34e4628453
commit 2d26af82c1
1 changed files with 2 additions and 1 deletions
--- a/Doc/library/asyncio-task.rst
+++ b/Doc/library/asyncio-task.rst
@ -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)