From 9181e2e2f3ade85f65bf2521a5deb898434dfd64 Mon Sep 17 00:00:00 2001 From: "Miss Islington (bot)" <31488909+miss-islington@users.noreply.github.com> Date: Sat, 23 May 2020 16:23:53 -0700 Subject: bpo-40405: Fix asyncio.as_completed docs (GH-19753) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * 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 Co-Authored-By: Kyle Stanley Co-Authored-By: Yury Selivanov (cherry picked from commit 13206b52d16c2489f4c7dd2dce2a7f48a554b5ed) Co-authored-by: Bar Harel --- Doc/library/asyncio-task.rst | 10 +++++----- 1 file 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 ` 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 # ... -- cgit v0.12