bpo-40405: Fix asyncio.as_completed docs (GH-19753)

bharel · Rémi Lapeyre · aeros · web-flow · commit 13206b52d16c · 2020-05-23T19:14:31.000-04:00
* 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 &lt;remi.lapeyre@henki.fr&gt;
Co-Authored-By: Kyle Stanley &lt;aeros167@gmail.com&gt;
Co-Authored-By: Yury Selivanov &lt;yury@edgedb.com&gt;
diff --git 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
            # ...
 
 
