[Python-checkins] Update concurrent.futures.rst (GH-14061)
Miss Islington (bot)
webhook-mailer at python.org
Fri Jun 14 11:11:13 EDT 2019
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: GitHub <noreply at github.com>
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 431478d5d74d880692817323198b9605af972fa5)
Co-authored-by: Géry Ogam <gery.ogam at gmail.com>
diff --git a/Doc/library/concurrent.futures.rst b/Doc/library/concurrent.futures.rst
index f2491dd24571..41d47c7ef153 100644
@@ -306,9 +306,10 @@ 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 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. 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``.
.. method:: cancelled()
@@ -423,8 +424,9 @@ Module Functions
Wait for the :class:`Future` instances (possibly created by different
:class:`Executor` instances) given by *fs* to complete. Returns a named
2-tuple of sets. The first set, named ``done``, contains the futures that
- completed (finished or were cancelled) before the wait completed. The second
- set, named ``not_done``, contains uncompleted futures.
+ completed (finished or cancelled futures) before the wait completed. The
+ second set, named ``not_done``, contains the futures that did not complete
+ (pending or running futures).
*timeout* can be used to control the maximum number of seconds to wait before
returning. *timeout* can be an int or float. If *timeout* is not specified
@@ -455,7 +457,7 @@ Module Functions
Returns an iterator over the :class:`Future` instances (possibly created by
different :class:`Executor` instances) given by *fs* that yields futures as
- they complete (finished or were cancelled). Any futures given by *fs* that
+ they complete (finished or cancelled futures). Any futures given by *fs* that
are duplicated will be returned once. Any futures that completed before
:func:`as_completed` is called will be yielded first. The returned iterator
raises a :exc:`concurrent.futures.TimeoutError` if :meth:`~iterator.__next__`
More information about the Python-checkins