summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>2024-01-21 13:22:57 (GMT)
committerGitHub <noreply@github.com>2024-01-21 13:22:57 (GMT)
commitafefa4a74cecc505a54094c6a0f129fcdc02060a (patch)
tree65a268297c2dea74570ae35f5d3fd64e64810822
parent24fa45b59f29e90cc37e83c4e2908b1377717f32 (diff)
downloadcpython-afefa4a74cecc505a54094c6a0f129fcdc02060a.zip
cpython-afefa4a74cecc505a54094c6a0f129fcdc02060a.tar.gz
cpython-afefa4a74cecc505a54094c6a0f129fcdc02060a.tar.bz2
[3.12] gh-114384: Align sys.set_asyncgen_hooks signature in docs to reflect implementation (GH-114385) (#114386)
(cherry picked from commit 38768e4cdd1c4b6e03702da8a94e1c22479d6ed3) Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
-rw-r--r--Doc/library/sys.rst2
-rw-r--r--Python/sysmodule.c2
2 files changed, 2 insertions, 2 deletions
diff --git a/Doc/library/sys.rst b/Doc/library/sys.rst
index af0eae6..62783a4 100644
--- a/Doc/library/sys.rst
+++ b/Doc/library/sys.rst
@@ -1641,7 +1641,7 @@ always available.
``'opcode'`` event type added; :attr:`~frame.f_trace_lines` and
:attr:`~frame.f_trace_opcodes` attributes added to frames
-.. function:: set_asyncgen_hooks(firstiter, finalizer)
+.. function:: set_asyncgen_hooks([firstiter] [, finalizer])
Accepts two optional keyword arguments which are callables that accept an
:term:`asynchronous generator iterator` as an argument. The *firstiter*
diff --git a/Python/sysmodule.c b/Python/sysmodule.c
index 14f4447..7874920 100644
--- a/Python/sysmodule.c
+++ b/Python/sysmodule.c
@@ -1361,7 +1361,7 @@ sys_set_asyncgen_hooks(PyObject *self, PyObject *args, PyObject *kw)
}
PyDoc_STRVAR(set_asyncgen_hooks_doc,
-"set_asyncgen_hooks(* [, firstiter] [, finalizer])\n\
+"set_asyncgen_hooks([firstiter] [, finalizer])\n\
\n\
Set a finalizer for async generators objects."
);