Skip to content

Commit 047fa1d

Browse files
Update concurrent.futures.rst (GH-14061)
This PR adds missing details in the [`concurrent.futures`](https://docs.python.org/3/library/concurrent.futures.html) documentation: * the mention that `Future.cancel` also returns `False` if the call finished running; * the mention of the states for `Future` that did not complete: pending or running. (cherry picked from commit 431478d) Co-authored-by: Géry Ogam <gery.ogam@gmail.com>
1 parent 8b66dbb commit 047fa1d

1 file changed

Lines changed: 8 additions & 6 deletions

File tree

‎Doc/library/concurrent.futures.rst‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -306,9 +306,10 @@ The :class:`Future` class encapsulates the asynchronous execution of a callable.
306306

307307
.. method:: cancel()
308308

309-
Attempt to cancel the call. If the call is currently being executed and
310-
cannot be cancelled then the method will return ``False``, otherwise the
311-
call will be cancelled and the method will return ``True``.
309+
Attempt to cancel the call. If the call is currently being executed or
310+
finished running and cannot be cancelled then the method will return
311+
``False``, otherwise the call will be cancelled and the method will
312+
return ``True``.
312313

313314
.. method:: cancelled()
314315

@@ -423,8 +424,9 @@ Module Functions
423424
Wait for the :class:`Future` instances (possibly created by different
424425
:class:`Executor` instances) given by *fs* to complete. Returns a named
425426
2-tuple of sets. The first set, named ``done``, contains the futures that
426-
completed (finished or were cancelled) before the wait completed. The second
427-
set, named ``not_done``, contains uncompleted futures.
427+
completed (finished or cancelled futures) before the wait completed. The
428+
second set, named ``not_done``, contains the futures that did not complete
429+
(pending or running futures).
428430

429431
*timeout* can be used to control the maximum number of seconds to wait before
430432
returning. *timeout* can be an int or float. If *timeout* is not specified
@@ -455,7 +457,7 @@ Module Functions
455457

456458
Returns an iterator over the :class:`Future` instances (possibly created by
457459
different :class:`Executor` instances) given by *fs* that yields futures as
458-
they complete (finished or were cancelled). Any futures given by *fs* that
460+
they complete (finished or cancelled futures). Any futures given by *fs* that
459461
are duplicated will be returned once. Any futures that completed before
460462
:func:`as_completed` is called will be yielded first. The returned iterator
461463
raises a :exc:`concurrent.futures.TimeoutError` if :meth:`~iterator.__next__`

0 commit comments

Comments
 (0)