Skip to content

bpo-23859: Document that asyncio.wait() does not cancel its futures #7217

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
May 29, 2018
Merged

bpo-23859: Document that asyncio.wait() does not cancel its futures #7217

Show file tree
Hide file tree
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
3 changes: 3 additions & 0 deletions Doc/library/asyncio-task.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -764,6 +764,9 @@ Task functions
| | futures finish or are cancelled. |
+-----------------------------+----------------------------------------+

Unlike :func:`~asyncio.wait_for`, ``wait()`` will not cancel the futures
when a timeout accurs.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo: occurs, no?


This function is a :ref:`coroutine <coroutine>`.

Usage::
Expand Down
1 change: 1 addition & 0 deletions Misc/NEWS.d/next/Documentation/2018-05-29-16-02-31.bpo-23859.E5gba1.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Document that `asyncio.wait()` does not cancel its futures on timeout.