diff options
| author | Eli Bendersky <eliben@gmail.com> | 2014-01-20 15:02:22 (GMT) |
|---|---|---|
| committer | Eli Bendersky <eliben@gmail.com> | 2014-01-20 15:02:22 (GMT) |
| commit | 029981bbfc58f53db01672846d8e31b345824652 (patch) | |
| tree | 49043017090e3529de7dc320838e5e20b65986ce /Doc/library/asyncio-task.rst | |
| parent | 2d26af82c1639d4aa709ed68f68673e7bd7e1bf4 (diff) | |
| download | cpython-029981bbfc58f53db01672846d8e31b345824652.zip cpython-029981bbfc58f53db01672846d8e31b345824652.tar.gz cpython-029981bbfc58f53db01672846d8e31b345824652.tar.bz2 | |
Clarify what the loop arguments means for functions listed in 18.5.2.5
Diffstat (limited to 'Doc/library/asyncio-task.rst')
| -rw-r--r-- | 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 index e4abacd..81372c5 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` |