]> granicus.if.org Git - python/commitdiff
Clarify what the loop arguments means for functions listed in 18.5.2.5
authorEli Bendersky <eliben@gmail.com>
Mon, 20 Jan 2014 15:02:22 +0000 (07:02 -0800)
committerEli Bendersky <eliben@gmail.com>
Mon, 20 Jan 2014 15:02:22 +0000 (07:02 -0800)
Doc/library/asyncio-task.rst

index e4abacd135afdf0cd0cb531d17b92e6828fc412d..81372c52f7c82e00b81254e88f5967e11c2fd8aa 100644 (file)
@@ -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`