[Python-checkins] cpython: Clarify what the loop arguments means for functions listed in 18.5.2.5

[eli.bendersky]

http://hg.python.org/cpython/rev/84869a6d6403
changeset:   88583:84869a6d6403
user:        Eli Bendersky <eliben at gmail.com>
date:        Mon Jan 20 07:02:22 2014 -0800
summary:
  Clarify what the loop arguments means for functions listed in 18.5.2.5

files:
  Doc/library/asyncio-task.rst |  6 ++++++
  1 files changed, 6 insertions(+), 0 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
@@ -374,6 +374,12 @@
 Task functions
 --------------
 
+.. note::
+
+   In the functions below, the optional *loop* argument allows to explicitly set
+   the event loop object used by the underlying task or coroutine.  If it's
+   not provided, the default event loop is used.
+
 .. function:: as_completed(fs, \*, loop=None, timeout=None)
 
    Return an iterator whose values, when waited for, are :class:`Future`

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