From: Eli Bendersky <eliben@gmail.com>
Date: Mon, 20 Jan 2014 15:02:22 +0000 (-0800)
Subject: Clarify what the loop arguments means for functions listed in 18.5.2.5
X-Git-Tag: v3.4.0b3~87
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=029981bbfc58f53db01672846d8e31b345824652;p=thirdparty%2FPython%2Fcpython.git

Clarify what the loop arguments means for functions listed in 18.5.2.5
---

diff --git a/Doc/library/asyncio-task.rst b/Doc/library/asyncio-task.rst
index e4abacd135af..81372c52f7c8 100644
--- a/Doc/library/asyncio-task.rst
+++ b/Doc/library/asyncio-task.rst
@@ -374,6 +374,12 @@ loop stops when all tasks are done.
 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`