Skip to content

Commit 085e5d7

Browse files
hugovksobolevn
andauthored
[3.12] gh-101100: Fix sphinx warnings in concurrent.futures.rst (GH-114521) (#114525)
Co-authored-by: Nikita Sobolev <[email protected]>
1 parent c912bc3 commit 085e5d7

File tree

2 files changed

+22
-21
lines changed

2 files changed

+22
-21
lines changed

Doc/library/concurrent.futures.rst

Lines changed: 22 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -271,7 +271,8 @@ to a :class:`ProcessPoolExecutor` will result in deadlock.
271271

272272
.. versionchanged:: 3.3
273273
When one of the worker processes terminates abruptly, a
274-
:exc:`BrokenProcessPool` error is now raised. Previously, behaviour
274+
:exc:`~concurrent.futures.process.BrokenProcessPool` error is now raised.
275+
Previously, behaviour
275276
was undefined but operations on the executor or its futures would often
276277
freeze or deadlock.
277278

@@ -485,23 +486,22 @@ Module Functions
485486
*return_when* indicates when this function should return. It must be one of
486487
the following constants:
487488

488-
.. tabularcolumns:: |l|L|
489-
490-
+-----------------------------+----------------------------------------+
491-
| Constant | Description |
492-
+=============================+========================================+
493-
| :const:`FIRST_COMPLETED` | The function will return when any |
494-
| | future finishes or is cancelled. |
495-
+-----------------------------+----------------------------------------+
496-
| :const:`FIRST_EXCEPTION` | The function will return when any |
497-
| | future finishes by raising an |
498-
| | exception. If no future raises an |
499-
| | exception then it is equivalent to |
500-
| | :const:`ALL_COMPLETED`. |
501-
+-----------------------------+----------------------------------------+
502-
| :const:`ALL_COMPLETED` | The function will return when all |
503-
| | futures finish or are cancelled. |
504-
+-----------------------------+----------------------------------------+
489+
.. list-table::
490+
:header-rows: 1
491+
492+
* - Constant
493+
- Description
494+
495+
* - .. data:: FIRST_COMPLETED
496+
- The function will return when any future finishes or is cancelled.
497+
498+
* - .. data:: FIRST_EXCEPTION
499+
- The function will return when any future finishes by raising an
500+
exception. If no future raises an exception
501+
then it is equivalent to :const:`ALL_COMPLETED`.
502+
503+
* - .. data:: ALL_COMPLETED
504+
- The function will return when all futures finish or are cancelled.
505505

506506
.. function:: as_completed(fs, timeout=None)
507507

@@ -562,7 +562,8 @@ Exception classes
562562
.. exception:: BrokenThreadPool
563563

564564
Derived from :exc:`~concurrent.futures.BrokenExecutor`, this exception
565-
class is raised when one of the workers of a :class:`ThreadPoolExecutor`
565+
class is raised when one of the workers
566+
of a :class:`~concurrent.futures.ThreadPoolExecutor`
566567
has failed initializing.
567568

568569
.. versionadded:: 3.7
@@ -573,7 +574,8 @@ Exception classes
573574

574575
Derived from :exc:`~concurrent.futures.BrokenExecutor` (formerly
575576
:exc:`RuntimeError`), this exception class is raised when one of the
576-
workers of a :class:`ProcessPoolExecutor` has terminated in a non-clean
577+
workers of a :class:`~concurrent.futures.ProcessPoolExecutor`
578+
has terminated in a non-clean
577579
fashion (for example, if it was killed from the outside).
578580

579581
.. versionadded:: 3.3

Doc/tools/.nitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,6 @@ Doc/library/bdb.rst
3535
Doc/library/cgi.rst
3636
Doc/library/chunk.rst
3737
Doc/library/collections.rst
38-
Doc/library/concurrent.futures.rst
3938
Doc/library/copy.rst
4039
Doc/library/csv.rst
4140
Doc/library/datetime.rst

0 commit comments

Comments
 (0)