https://github.com/python/cpython/commit/0c42897f8d3bf0fbd4d10463a0628d6074efa7e6
commit: 0c42897f8d3bf0fbd4d10463a0628d6074efa7e6
branch: 3.12
author: Hugo van Kemenade <1324225+hug...@users.noreply.github.com>
committer: hugovk <1324225+hug...@users.noreply.github.com>
date: 2024-01-24T00:40:22-07:00
summary:
[3.12] gh-101100: Fix sphinx warnings in `asyncio-task.rst` (GH-114469)
(#114519)
Co-authored-by: Nikita Sobolev <m...@sobolevn.me>
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 a3ea050c0713ac..a964c8b797ef96 100644
--- a/Doc/library/asyncio-task.rst
+++ b/Doc/library/asyncio-task.rst
@@ -825,23 +825,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 df34700e285601..cb6e70a6a2b093 100644
--- a/Doc/tools/.nitignore
+++ b/Doc/tools/.nitignore
@@ -30,7 +30,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/audioop.rst
Doc/library/bdb.rst
Doc/library/cgi.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
