Skip to content

Clarify Future.cancel() behavior #154949

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

Open
chyin6 wants to merge 1 commit into
base: main
Choose a base branch
from
+3 −4
Open

Clarify Future.cancel() behavior #154949

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
7 changes: 3 additions & 4 deletions Doc/library/concurrent.futures.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -504,10 +504,9 @@ The :class:`Future` class encapsulates the asynchronous execution of a callable.

.. method:: cancel()

Attempt to cancel the call. If the call is currently being executed or
finished running and cannot be cancelled then the method will return
``False``, otherwise the call will be cancelled and the method will
return ``True``.
Attempt to cancel the call. Return ``False`` if the call cannot be
cancelled because it is already running or has finished. Otherwise, cancel
the call and return ``True``.

.. method:: cancelled()

Expand Down
Loading