Skip to content

Commit 8744ecf

Browse files
authored
gh-101100: Fix sphinx warnings in concurrent.futures.rst (#114521)
1 parent 384429d commit 8744ecf

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
@@ -275,7 +275,8 @@ to a :class:`ProcessPoolExecutor` will result in deadlock.
275275

276276
.. versionchanged:: 3.3
277277
When one of the worker processes terminates abruptly, a
278-
:exc:`BrokenProcessPool` error is now raised. Previously, behaviour
278+
:exc:`~concurrent.futures.process.BrokenProcessPool` error is now raised.
279+
Previously, behaviour
279280
was undefined but operations on the executor or its futures would often
280281
freeze or deadlock.
281282

@@ -493,23 +494,22 @@ Module Functions
493494
*return_when* indicates when this function should return. It must be one of
494495
the following constants:
495496

496-
.. tabularcolumns:: |l|L|
497-
498-
+-----------------------------+----------------------------------------+
499-
| Constant | Description |
500-
+=============================+========================================+
501-
| :const:`FIRST_COMPLETED` | The function will return when any |
502-
| | future finishes or is cancelled. |
503-
+-----------------------------+----------------------------------------+
504-
| :const:`FIRST_EXCEPTION` | The function will return when any |
505-
| | future finishes by raising an |
506-
| | exception. If no future raises an |
507-
| | exception then it is equivalent to |
508-
| | :const:`ALL_COMPLETED`. |
509-
+-----------------------------+----------------------------------------+
510-
| :const:`ALL_COMPLETED` | The function will return when all |
511-
| | futures finish or are cancelled. |
512-
+-----------------------------+----------------------------------------+
497+
.. list-table::
498+
:header-rows: 1
499+
500+
* - Constant
501+
- Description
502+
503+
* - .. data:: FIRST_COMPLETED
504+
- The function will return when any future finishes or is cancelled.
505+
506+
* - .. data:: FIRST_EXCEPTION
507+
- The function will return when any future finishes by raising an
508+
exception. If no future raises an exception
509+
then it is equivalent to :const:`ALL_COMPLETED`.
510+
511+
* - .. data:: ALL_COMPLETED
512+
- The function will return when all futures finish or are cancelled.
513513

514514
.. function:: as_completed(fs, timeout=None)
515515

@@ -570,7 +570,8 @@ Exception classes
570570
.. exception:: BrokenThreadPool
571571

572572
Derived from :exc:`~concurrent.futures.BrokenExecutor`, this exception
573-
class is raised when one of the workers of a :class:`ThreadPoolExecutor`
573+
class is raised when one of the workers
574+
of a :class:`~concurrent.futures.ThreadPoolExecutor`
574575
has failed initializing.
575576

576577
.. versionadded:: 3.7
@@ -581,7 +582,8 @@ Exception classes
581582

582583
Derived from :exc:`~concurrent.futures.BrokenExecutor` (formerly
583584
:exc:`RuntimeError`), this exception class is raised when one of the
584-
workers of a :class:`ProcessPoolExecutor` has terminated in a non-clean
585+
workers of a :class:`~concurrent.futures.ProcessPoolExecutor`
586+
has terminated in a non-clean
585587
fashion (for example, if it was killed from the outside).
586588

587589
.. 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/csv.rst
3433
Doc/library/datetime.rst
3534
Doc/library/dbm.rst

0 commit comments

Comments
 (0)