summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEli Bendersky <eliben@gmail.com>2014-01-20 06:59:23 -0800
committerEli Bendersky <eliben@gmail.com>2014-01-20 06:59:23 -0800
commit2d26af82c1639d4aa709ed68f68673e7bd7e1bf4 (patch)
tree722af31319ecc17142b7f877fa71e468c36387ca
parent34e4628453a01330a41c0d0baddc1408a38e5de4 (diff)
downloadcpython-git-2d26af82c1639d4aa709ed68f68673e7bd7e1bf4.tar.gz
Explain the 'result' argument in asyncio.sleep
-rw-r--r--Doc/library/asyncio-task.rst3
1 files changed, 2 insertions, 1 deletions
diff --git a/Doc/library/asyncio-task.rst b/Doc/library/asyncio-task.rst
index 43b506008c..e4abacd135 100644
--- 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)