[Python-checkins] [3.11] gh-107980: fix doc role for asyncio.timeouts (GH-108126) (#108153)

AlexWaygood webhook-mailer at python.org
Sun Aug 20 06:12:19 EDT 2023


https://github.com/python/cpython/commit/5d366f28ae5a3a6be9819280e4faf7e12e4407ca
commit: 5d366f28ae5a3a6be9819280e4faf7e12e4407ca
branch: 3.11
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: AlexWaygood <Alex.Waygood at Gmail.com>
date: 2023-08-20T11:12:15+01:00
summary:

[3.11] gh-107980: fix doc role for asyncio.timeouts (GH-108126) (#108153)

gh-107980: fix doc role for asyncio.timeouts (GH-108126)
(cherry picked from commit a47c13cae5b32e6f3d7532cc6dbb4e1ac31219de)

Co-authored-by: Tin Tvrtković <tinchester at gmail.com>

files:
M Doc/library/asyncio-task.rst

diff --git a/Doc/library/asyncio-task.rst b/Doc/library/asyncio-task.rst
index ad5466b12b651..ef17f384c1bfe 100644
--- a/Doc/library/asyncio-task.rst
+++ b/Doc/library/asyncio-task.rst
@@ -578,9 +578,9 @@ Shielding From Cancellation
 Timeouts
 ========
 
-.. coroutinefunction:: timeout(delay)
+.. function:: timeout(delay)
 
-    An :ref:`asynchronous context manager <async-context-managers>`
+    Return an :ref:`asynchronous context manager <async-context-managers>`
     that can be used to limit the amount of time spent waiting on
     something.
 
@@ -671,7 +671,7 @@ Timeouts
 
     .. versionadded:: 3.11
 
-.. coroutinefunction:: timeout_at(when)
+.. function:: timeout_at(when)
 
    Similar to :func:`asyncio.timeout`, except *when* is the absolute time
    to stop waiting, or ``None``.



More information about the Python-checkins mailing list