Explain the 'result' argument in asyncio.sleep

2d26af82 · Eli Bendersky · 34e46284 · 2d26af82
Commit 2d26af82 authored Jan 20, 2014 by Eli Bendersky
Hide whitespace changes
Inline Side-by-side

Showing with 2 additions and 1 deletion

Doc/library/asyncio-task.rst Doc/library/asyncio-task.rst +2 -1

No files found.
--- 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)