Skip to content

Commit aa17d91

Browse files
hugovksobolevn
andauthored
[3.11] gh-101100: Fix sphinx warnings in concurrent.futures.rst (GH-114521) (#114526)
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
1 parent 208db89 commit aa17d91

File tree

2 files changed

+22
-21
lines changed

2 files changed

+22
-21
lines changed

Doc/library/concurrent.futures.rst

+22-20
Original file line numberDiff line numberDiff line change
@@ -270,7 +270,8 @@ to a :class:`ProcessPoolExecutor` will result in deadlock.
270270

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

@@ -469,23 +470,22 @@ Module Functions
469470
*return_when* indicates when this function should return. It must be one of
470471
the following constants:
471472

472-
.. tabularcolumns:: |l|L|
473-
474-
+-----------------------------+----------------------------------------+
475-
| Constant | Description |
476-
+=============================+========================================+
477-
| :const:`FIRST_COMPLETED` | The function will return when any |
478-
| | future finishes or is cancelled. |
479-
+-----------------------------+----------------------------------------+
480-
| :const:`FIRST_EXCEPTION` | The function will return when any |
481-
| | future finishes by raising an |
482-
| | exception. If no future raises an |
483-
| | exception then it is equivalent to |
484-
| | :const:`ALL_COMPLETED`. |
485-
+-----------------------------+----------------------------------------+
486-
| :const:`ALL_COMPLETED` | The function will return when all |
487-
| | futures finish or are cancelled. |
488-
+-----------------------------+----------------------------------------+
473+
.. list-table::
474+
:header-rows: 1
475+
476+
* - Constant
477+
- Description
478+
479+
* - .. data:: FIRST_COMPLETED
480+
- The function will return when any future finishes or is cancelled.
481+
482+
* - .. data:: FIRST_EXCEPTION
483+
- The function will return when any future finishes by raising an
484+
exception. If no future raises an exception
485+
then it is equivalent to :const:`ALL_COMPLETED`.
486+
487+
* - .. data:: ALL_COMPLETED
488+
- The function will return when all futures finish or are cancelled.
489489

490490
.. function:: as_completed(fs, timeout=None)
491491

@@ -546,7 +546,8 @@ Exception classes
546546
.. exception:: BrokenThreadPool
547547

548548
Derived from :exc:`~concurrent.futures.BrokenExecutor`, this exception
549-
class is raised when one of the workers of a :class:`ThreadPoolExecutor`
549+
class is raised when one of the workers
550+
of a :class:`~concurrent.futures.ThreadPoolExecutor`
550551
has failed initializing.
551552

552553
.. versionadded:: 3.7
@@ -557,7 +558,8 @@ Exception classes
557558

558559
Derived from :exc:`~concurrent.futures.BrokenExecutor` (formerly
559560
:exc:`RuntimeError`), this exception class is raised when one of the
560-
workers of a :class:`ProcessPoolExecutor` has terminated in a non-clean
561+
workers of a :class:`~concurrent.futures.ProcessPoolExecutor`
562+
has terminated in a non-clean
561563
fashion (for example, if it was killed from the outside).
562564

563565
.. versionadded:: 3.3

Doc/tools/.nitignore

-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,6 @@ Doc/library/asyncio-policy.rst
2929
Doc/library/asyncio-subprocess.rst
3030
Doc/library/bdb.rst
3131
Doc/library/collections.rst
32-
Doc/library/concurrent.futures.rst
3332
Doc/library/copy.rst
3433
Doc/library/csv.rst
3534
Doc/library/ctypes.rst

0 commit comments

Comments
 (0)