Skip to content

Commit 0c42897

Browse files
hugovksobolevnserhiy-storchaka
authored
[3.12] gh-101100: Fix sphinx warnings in asyncio-task.rst (GH-114469) (#114519)
Co-authored-by: Nikita Sobolev <[email protected]> Co-authored-by: Serhiy Storchaka <[email protected]>
1 parent 2692f5b commit 0c42897

File tree

2 files changed

+16
-18
lines changed

2 files changed

+16
-18
lines changed

Doc/library/asyncio-task.rst

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -825,23 +825,22 @@ Waiting Primitives
825825
*return_when* indicates when this function should return. It must
826826
be one of the following constants:
827827

828-
.. tabularcolumns:: |l|L|
829-
830-
+-----------------------------+----------------------------------------+
831-
| Constant | Description |
832-
+=============================+========================================+
833-
| :const:`FIRST_COMPLETED` | The function will return when any |
834-
| | future finishes or is cancelled. |
835-
+-----------------------------+----------------------------------------+
836-
| :const:`FIRST_EXCEPTION` | The function will return when any |
837-
| | future finishes by raising an |
838-
| | exception. If no future raises an |
839-
| | exception then it is equivalent to |
840-
| | :const:`ALL_COMPLETED`. |
841-
+-----------------------------+----------------------------------------+
842-
| :const:`ALL_COMPLETED` | The function will return when all |
843-
| | futures finish or are cancelled. |
844-
+-----------------------------+----------------------------------------+
828+
.. list-table::
829+
:header-rows: 1
830+
831+
* - Constant
832+
- Description
833+
834+
* - .. data:: FIRST_COMPLETED
835+
- The function will return when any future finishes or is cancelled.
836+
837+
* - .. data:: FIRST_EXCEPTION
838+
- The function will return when any future finishes by raising an
839+
exception. If no future raises an exception
840+
then it is equivalent to :const:`ALL_COMPLETED`.
841+
842+
* - .. data:: ALL_COMPLETED
843+
- The function will return when all futures finish or are cancelled.
845844

846845
Unlike :func:`~asyncio.wait_for`, ``wait()`` does not cancel the
847846
futures when a timeout occurs.

Doc/tools/.nitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,6 @@ Doc/library/ast.rst
3030
Doc/library/asyncio-extending.rst
3131
Doc/library/asyncio-policy.rst
3232
Doc/library/asyncio-subprocess.rst
33-
Doc/library/asyncio-task.rst
3433
Doc/library/audioop.rst
3534
Doc/library/bdb.rst
3635
Doc/library/cgi.rst

0 commit comments

Comments
 (0)