languages/cpython
languages/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython synced 2024-10-14 19:36:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse source 
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
This commit is contained in:
Nikita Sobolev 2024-01-24 10:23:34 +03:00 committed by GitHub
parent ce75b4c26d
commit 1e4f00ebd8
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 15 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
Doc/library/asyncio-task.rst
View file

@ -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|
.. list-table::
:header-rows: 1
+-----------------------------+----------------------------------------+
| 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. |
+-----------------------------+----------------------------------------+
* - 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.

1
Doc/tools/.nitignore
View file

@ -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