Skip to content

Commit 1e4f00e

Browse files
gh-101100: Fix sphinx warnings in asyncio-task.rst (#114469)
Co-authored-by: Serhiy Storchaka <[email protected]>
1 parent ce75b4c commit 1e4f00e

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
@@ -828,23 +828,22 @@ Waiting Primitives
828828
*return_when* indicates when this function should return. It must
829829
be one of the following constants:
830830

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

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

Doc/tools/.nitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@ Doc/library/ast.rst
2727
Doc/library/asyncio-extending.rst
2828
Doc/library/asyncio-policy.rst
2929
Doc/library/asyncio-subprocess.rst
30-
Doc/library/asyncio-task.rst
3130
Doc/library/bdb.rst
3231
Doc/library/collections.rst
3332
Doc/library/concurrent.futures.rst

0 commit comments

Comments
 (0)