diff options
| author | Bar Harel <bzvi7919@gmail.com> | 2020-05-23 23:14:31 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-05-23 23:14:31 (GMT) |
| commit | 13206b52d16c2489f4c7dd2dce2a7f48a554b5ed (patch) | |
| tree | 02fb024db70a931b5c2fa487ba0f145fb3e4ae3d | |
| parent | 1cba1c9abadf76f458ecf883a48515aa3b534dbd (diff) | |
| download | cpython-13206b52d16c2489f4c7dd2dce2a7f48a554b5ed.zip cpython-13206b52d16c2489f4c7dd2dce2a7f48a554b5ed.tar.gz cpython-13206b52d16c2489f4c7dd2dce2a7f48a554b5ed.tar.bz2 | |
bpo-40405: Fix asyncio.as_completed docs (GH-19753)
* Fix as_completed docs to correctly state the function return value.
* Also, improves the general wording of the as_completed documentation.
Co-Authored-By: Rémi Lapeyre <remi.lapeyre@henki.fr>
Co-Authored-By: Kyle Stanley <aeros167@gmail.com>
Co-Authored-By: Yury Selivanov <yury@edgedb.com>
| -rw-r--r-- | Doc/library/asyncio-task.rst | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/Doc/library/asyncio-task.rst b/Doc/library/asyncio-task.rst index dd94c14..847363b 100644 --- a/Doc/library/asyncio-task.rst +++ b/Doc/library/asyncio-task.rst @@ -585,9 +585,9 @@ Waiting Primitives .. function:: as_completed(aws, \*, loop=None, timeout=None) Run :ref:`awaitable objects <asyncio-awaitables>` in the *aws* - set concurrently. Return an iterator of :class:`Future` objects. - Each Future object returned represents the earliest result - from the set of the remaining awaitables. + set concurrently. Return an iterator of coroutines. + Each coroutine returned can be awaited to get the earliest next + result from the set of the remaining awaitables. Raises :exc:`asyncio.TimeoutError` if the timeout occurs before all Futures are done. @@ -597,8 +597,8 @@ Waiting Primitives Example:: - for f in as_completed(aws): - earliest_result = await f + for coro in as_completed(aws): + earliest_result = await coro # ... |