diff options
| author | Nikita Sobolev <mail@sobolevn.me> | 2024-01-24 07:23:34 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-01-24 07:23:34 (GMT) |
| commit | 1e4f00ebd8db44a031b61eed0803b4c3d731aed7 (patch) | |
| tree | 4c95a2f1f2b266f35650b639b5931a885e4260c4 /Doc/library/asyncio-task.rst | |
| parent | ce75b4c26d18dcd840fd2e7ee362a84209648d06 (diff) | |
| download | cpython-1e4f00ebd8db44a031b61eed0803b4c3d731aed7.zip cpython-1e4f00ebd8db44a031b61eed0803b4c3d731aed7.tar.gz cpython-1e4f00ebd8db44a031b61eed0803b4c3d731aed7.tar.bz2 | |
gh-101100: Fix sphinx warnings in `asyncio-task.rst` (#114469)
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
Diffstat (limited to 'Doc/library/asyncio-task.rst')
| -rw-r--r-- | Doc/library/asyncio-task.rst | 33 |
1 files changed, 16 insertions, 17 deletions
diff --git a/Doc/library/asyncio-task.rst b/Doc/library/asyncio-task.rst index 797065c..24bd36e 100644 --- a/Doc/library/asyncio-task.rst +++ b/Doc/library/asyncio-task.rst @@ -828,23 +828,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. |