diff options
| author | Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> | 2024-01-24 07:32:00 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-01-24 07:32:00 (GMT) |
| commit | 208db89fe66077678e2670ec262ee9cd69c284e7 (patch) | |
| tree | 33959dfc85d28570cb7da47aa689b8d78df97768 /Doc | |
| parent | b39a314edaf15716e9d9a2ff1d11ac79e09d97fa (diff) | |
| download | cpython-208db89fe66077678e2670ec262ee9cd69c284e7.zip cpython-208db89fe66077678e2670ec262ee9cd69c284e7.tar.gz cpython-208db89fe66077678e2670ec262ee9cd69c284e7.tar.bz2 | |
[3.11] gh-101100: Fix sphinx warnings in `asyncio-task.rst` (GH-114469) (#114518)
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
Diffstat (limited to 'Doc')
| -rw-r--r-- | Doc/library/asyncio-task.rst | 33 | ||||
| -rw-r--r-- | Doc/tools/.nitignore | 1 |
2 files changed, 16 insertions, 18 deletions
diff --git a/Doc/library/asyncio-task.rst b/Doc/library/asyncio-task.rst index 0944aef..12d12ff 100644 --- a/Doc/library/asyncio-task.rst +++ b/Doc/library/asyncio-task.rst @@ -775,23 +775,22 @@ Waiting Primitives *return_when* indicates when this function should return. It must be one of the following constants: - .. tabularcolumns:: |l|L| - - +-----------------------------+----------------------------------------+ - | Constant | Description | - +=============================+========================================+ - | :const:`FIRST_COMPLETED` | The function will return when any | - | | future finishes or is cancelled. | - +-----------------------------+----------------------------------------+ - | :const:`FIRST_EXCEPTION` | The function will return when any | - | | future finishes by raising an | - | | exception. If no future raises an | - | | exception then it is equivalent to | - | | :const:`ALL_COMPLETED`. | - +-----------------------------+----------------------------------------+ - | :const:`ALL_COMPLETED` | The function will return when all | - | | futures finish or are cancelled. | - +-----------------------------+----------------------------------------+ + .. list-table:: + :header-rows: 1 + + * - Constant + - Description + + * - .. data:: FIRST_COMPLETED + - The function will return when any future finishes or is cancelled. + + * - .. data:: FIRST_EXCEPTION + - The function will return when any future finishes by raising an + exception. If no future raises an exception + then it is equivalent to :const:`ALL_COMPLETED`. + + * - .. data:: ALL_COMPLETED + - The function will return when all futures finish or are cancelled. Unlike :func:`~asyncio.wait_for`, ``wait()`` does not cancel the futures when a timeout occurs. diff --git a/Doc/tools/.nitignore b/Doc/tools/.nitignore index 1e244bf..7933382 100644 --- a/Doc/tools/.nitignore +++ b/Doc/tools/.nitignore @@ -27,7 +27,6 @@ Doc/library/ast.rst Doc/library/asyncio-extending.rst Doc/library/asyncio-policy.rst Doc/library/asyncio-subprocess.rst -Doc/library/asyncio-task.rst Doc/library/bdb.rst Doc/library/collections.rst Doc/library/concurrent.futures.rst |