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

gvanrossum webhook-mailer at python.org
Sat Aug 19 16:14:42 EDT 2023


https://github.com/python/cpython/commit/a47c13cae5b32e6f3d7532cc6dbb4e1ac31219de
commit: a47c13cae5b32e6f3d7532cc6dbb4e1ac31219de
branch: main
author: Tin Tvrtković <tinchester at gmail.com>
committer: gvanrossum <gvanrossum at gmail.com>
date: 2023-08-19T13:14:38-07:00
summary:

gh-107980: fix doc role for asyncio.timeouts (#108126)

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

diff --git a/Doc/library/asyncio-task.rst b/Doc/library/asyncio-task.rst
index 0651ff7213e52..1c419728c9a48 100644
--- a/Doc/library/asyncio-task.rst
+++ b/Doc/library/asyncio-task.rst
@@ -631,9 +631,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.
 
@@ -724,7 +724,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