Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

gh-101100: Fix sphinx warnings in asyncio-task.rst #114469

Merged
merged 2 commits into from
Jan 24, 2024
Merged

gh-101100: Fix sphinx warnings in asyncio-task.rst #114469

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6cba40c
gh-101100: Fix sphinx warnings in `asyncio-task.rst`
sobolevn Jan 23, 2024
6d88dc4
Update Doc/library/asyncio-task.rst
sobolevn Jan 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 16 additions & 17 deletions Doc/library/asyncio-task.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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::
sobolevn marked this conversation as resolved.
Show resolved Hide resolved
: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
View file
Open in desktop
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
Loading