Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 208db89

Browse files
miss-islingtonsobolevnserhiy-storchaka
authored
[3.11] gh-101100: Fix sphinx warnings in asyncio-task.rst (GH-114469) (#114518)
Co-authored-by: Nikita Sobolev <[email protected]> Co-authored-by: Serhiy Storchaka <[email protected]>
1 parent b39a314 commit 208db89

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

778-
.. tabularcolumns:: |l|L|
779-
780-
+-----------------------------+----------------------------------------+
781-
| Constant | Description |
782-
+=============================+========================================+
783-
| :const:`FIRST_COMPLETED` | The function will return when any |
784-
| | future finishes or is cancelled. |
785-
+-----------------------------+----------------------------------------+
786-
| :const:`FIRST_EXCEPTION` | The function will return when any |
787-
| | future finishes by raising an |
788-
| | exception. If no future raises an |
789-
| | exception then it is equivalent to |
790-
| | :const:`ALL_COMPLETED`. |
791-
+-----------------------------+----------------------------------------+
792-
| :const:`ALL_COMPLETED` | The function will return when all |
793-
| | futures finish or are cancelled. |
794-
+-----------------------------+----------------------------------------+
778+
.. list-table::
779+
:header-rows: 1
780+
781+
* - Constant
782+
- Description
783+
784+
* - .. data:: FIRST_COMPLETED
785+
- The function will return when any future finishes or is cancelled.
786+
787+
* - .. data:: FIRST_EXCEPTION
788+
- The function will return when any future finishes by raising an
789+
exception. If no future raises an exception
790+
then it is equivalent to :const:`ALL_COMPLETED`.
791+
792+
* - .. data:: ALL_COMPLETED
793+
- The function will return when all futures finish or are cancelled.
795794

796795
Unlike :func:`~asyncio.wait_for`, ``wait()`` does not cancel the
797796
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)