[Python-checkins] cpython: Explain the 'result' argument in asyncio.sleep

[eli.bendersky]

http://hg.python.org/cpython/rev/cc7d480a2bb0
changeset:   88582:cc7d480a2bb0
user:        Eli Bendersky <eliben at gmail.com>
date:        Mon Jan 20 06:59:23 2014 -0800
summary:
  Explain the 'result' argument in asyncio.sleep

files:
  Doc/library/asyncio-task.rst |  3 ++-
  1 files changed, 2 insertions(+), 1 deletions(-)


diff --git a/Doc/library/asyncio-task.rst b/Doc/library/asyncio-task.rst
--- a/Doc/library/asyncio-task.rst
+++ b/Doc/library/asyncio-task.rst
@@ -419,7 +419,8 @@
 .. 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)
 

-- 
Repository URL: http://hg.python.org/cpython