From: Eli Bendersky <eliben@gmail.com>
Date: Mon, 20 Jan 2014 14:59:23 +0000 (-0800)
Subject: Explain the 'result' argument in asyncio.sleep
X-Git-Tag: v3.4.0b3~88
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=2d26af82c1639d4aa709ed68f68673e7bd7e1bf4;p=python

Explain the 'result' argument in asyncio.sleep
---

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)