Skip to content

Update concurrent.futures.rst #14061

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
miss-islington merged 2 commits into from
Jun 14, 2019
Merged

Update concurrent.futures.rst #14061

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9a2ac1e
Update concurrent.futures.rst
geryogam Jun 13, 2019
924575e
Update concurrent.futures.rst
geryogam Jun 13, 2019
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
14 changes: 8 additions & 6 deletions Doc/library/concurrent.futures.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Comment thread
geryogam marked this conversation as resolved.
``False``, otherwise the call will be cancelled and the method will
return ``True``.

.. method:: cancelled()

Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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__`
Expand Down