Clarify description of wait().
This commit is contained in:
parent
14a51c65dd
commit
facc0c00cc
13
pep-3156.txt
13
pep-3156.txt
|
@ -765,12 +765,13 @@ and ``as_completed()`` APIs in the ``concurrent.futures`` package are
|
|||
provided:
|
||||
|
||||
- ``tulip.wait(fs, ...)``. Wait for the Futures or coroutines given
|
||||
by ``fs`` to complete. This is a coroutine whose result on success
|
||||
is a tuple of two sets of Futures, ``(done, not_done)``. Optional
|
||||
arguments ``timeout`` and ``return_when`` have the same meaning and
|
||||
defaults as for ``concurrent.futures.wait()``. The constants
|
||||
``FIRST_COMPLETED``, ``FIRST_EXCEPTION``, ``ALL_COMPLETED`` are
|
||||
defined with the same values and the same meanings as in PEP 3148.
|
||||
by ``fs`` to complete. Coroutine arguments will be wrapped in Tasks
|
||||
(see below). The result is a tuple of two sets of Futures, ``(done,
|
||||
not_done)``. Optional arguments ``timeout`` and ``return_when``
|
||||
have the same meaning and defaults as for
|
||||
``concurrent.futures.wait()``. The constants ``FIRST_COMPLETED``,
|
||||
``FIRST_EXCEPTION``, ``ALL_COMPLETED`` are defined with the same
|
||||
values and the same meanings as in PEP 3148.
|
||||
|
||||
- ``as_completed(fs, ...)``. Return an iterator whose values are
|
||||
coroutines; waiting for successive values waits until the next
|
||||
|
|
Loading…
Reference in New Issue