Skip to content

Commit

Permalink
[3.11] gh-101100: Fix sphinx warnings in asyncio-task.rst (GH-114469)…
Browse files Browse the repository at this point in the history
… (#114518)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
  • Loading branch information
3 people committed Jan 24, 2024
1 parent b39a314 commit 208db89
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 18 deletions.
33 changes: 16 additions & 17 deletions Doc/library/asyncio-task.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
1 change: 0 additions & 1 deletion Doc/tools/.nitignore
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 208db89

Please sign in to comment.