Clarify what the loop arguments means for functions listed in 18.5.2.5

This commit is contained in:
Eli Bendersky 2014-01-20 07:02:22 -08:00
parent 2d26af82c1
commit 029981bbfc
1 changed files with 6 additions and 0 deletions

View 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`