https://github.com/python/cpython/commit/1e4f00ebd8db44a031b61eed0803b4c3d731aed7
commit: 1e4f00ebd8db44a031b61eed0803b4c3d731aed7
branch: main
author: Nikita Sobolev <m...@sobolevn.me>
committer: hugovk <1324225+hug...@users.noreply.github.com>
date: 2024-01-24T00:23:34-07:00
summary:
gh-101100: Fix sphinx warnings in `asyncio-task.rst` (#114469)
Co-authored-by: Serhiy Storchaka <storch...@gmail.com>
files:
M Doc/library/asyncio-task.rst
M Doc/tools/.nitignore
diff --git a/Doc/library/asyncio-task.rst b/Doc/library/asyncio-task.rst
index 797065c8ccf894..24bd36e6431b4f 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.
diff --git a/Doc/tools/.nitignore b/Doc/tools/.nitignore
index 221a1f05c11e49..2114ec6dfacd7d 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
_______________________________________________
Python-checkins mailing list -- python-checkins@python.org
To unsubscribe send an email to python-checkins-le...@python.org
https://mail.python.org/mailman3/lists/python-checkins.python.org/
Member address: arch...@mail-archive.com
