[3.12] gh-101100: Fix sphinx warnings in concurrent.futures.rst (GH-114521) (#114525)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
This commit is contained in:
Hugo van Kemenade 2024-01-24 15:44:22 +02:00 committed by GitHub
parent c912bc3ed4
commit 085e5d765a
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 21 additions and 20 deletions

View file

@ -271,7 +271,8 @@ to a :class:`ProcessPoolExecutor` will result in deadlock.
.. versionchanged:: 3.3 .. versionchanged:: 3.3
When one of the worker processes terminates abruptly, a When one of the worker processes terminates abruptly, a
:exc:`BrokenProcessPool` error is now raised. Previously, behaviour :exc:`~concurrent.futures.process.BrokenProcessPool` error is now raised.
Previously, behaviour
was undefined but operations on the executor or its futures would often was undefined but operations on the executor or its futures would often
freeze or deadlock. freeze or deadlock.
@ -485,23 +486,22 @@ Module Functions
*return_when* indicates when this function should return. It must be one of *return_when* indicates when this function should return. It must be one of
the following constants: the following constants:
.. tabularcolumns:: |l|L| .. list-table::
:header-rows: 1
+-----------------------------+----------------------------------------+ * - Constant
| Constant | Description | - Description
+=============================+========================================+
| :const:`FIRST_COMPLETED` | The function will return when any | * - .. data:: FIRST_COMPLETED
| | future finishes or is cancelled. | - The function will return when any future finishes or is cancelled.
+-----------------------------+----------------------------------------+
| :const:`FIRST_EXCEPTION` | The function will return when any | * - .. data:: FIRST_EXCEPTION
| | future finishes by raising an | - The function will return when any future finishes by raising an
| | exception. If no future raises an | exception. If no future raises an exception
| | exception then it is equivalent to | then it is equivalent to :const:`ALL_COMPLETED`.
| | :const:`ALL_COMPLETED`. |
+-----------------------------+----------------------------------------+ * - .. data:: ALL_COMPLETED
| :const:`ALL_COMPLETED` | The function will return when all | - The function will return when all futures finish or are cancelled.
| | futures finish or are cancelled. |
+-----------------------------+----------------------------------------+
.. function:: as_completed(fs, timeout=None) .. function:: as_completed(fs, timeout=None)
@ -562,7 +562,8 @@ Exception classes
.. exception:: BrokenThreadPool .. exception:: BrokenThreadPool
Derived from :exc:`~concurrent.futures.BrokenExecutor`, this exception Derived from :exc:`~concurrent.futures.BrokenExecutor`, this exception
class is raised when one of the workers of a :class:`ThreadPoolExecutor` class is raised when one of the workers
of a :class:`~concurrent.futures.ThreadPoolExecutor`
has failed initializing. has failed initializing.
.. versionadded:: 3.7 .. versionadded:: 3.7
@ -573,7 +574,8 @@ Exception classes
Derived from :exc:`~concurrent.futures.BrokenExecutor` (formerly Derived from :exc:`~concurrent.futures.BrokenExecutor` (formerly
:exc:`RuntimeError`), this exception class is raised when one of the :exc:`RuntimeError`), this exception class is raised when one of the
workers of a :class:`ProcessPoolExecutor` has terminated in a non-clean workers of a :class:`~concurrent.futures.ProcessPoolExecutor`
has terminated in a non-clean
fashion (for example, if it was killed from the outside). fashion (for example, if it was killed from the outside).
.. versionadded:: 3.3 .. versionadded:: 3.3

View file

@ -35,7 +35,6 @@ Doc/library/bdb.rst
Doc/library/cgi.rst Doc/library/cgi.rst
Doc/library/chunk.rst Doc/library/chunk.rst
Doc/library/collections.rst Doc/library/collections.rst
Doc/library/concurrent.futures.rst
Doc/library/copy.rst Doc/library/copy.rst
Doc/library/csv.rst Doc/library/csv.rst
Doc/library/datetime.rst Doc/library/datetime.rst