Skip to content

[3.11] GH-78530: clarify docs for generators yielding tasks in asyncio.wait and asyncio.as_completed #103748

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 24, 2023
Merged

[3.11] GH-78530: clarify docs for generators yielding tasks in asyncio.wait and asyncio.as_completed #103748

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions Doc/library/asyncio-task.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -757,7 +757,7 @@ Waiting Primitives
iterable concurrently and block until the condition specified
by *return_when*.

The *aws* iterable must not be empty.
The *aws* iterable must not be empty and generators yielding tasks are not accepted.

Returns two sets of Tasks/Futures: ``(done, pending)``.

Expand Down Expand Up @@ -805,7 +805,8 @@ Waiting Primitives
.. function:: as_completed(aws, *, timeout=None)

Run :ref:`awaitable objects <asyncio-awaitables>` in the *aws*
iterable concurrently. Return an iterator of coroutines.
iterable concurrently. Generators yielding tasks are not accepted
as *aws* iterable. Return an iterator of coroutines.
Each coroutine returned can be awaited to get the earliest next
result from the iterable of the remaining awaitables.

Expand Down