https://github.com/python/cpython/commit/d2cfb5b258f8355f47fe461479cceb3a476176c6
commit: d2cfb5b258f8355f47fe461479cceb3a476176c6
branch: 3.11
author: Miss Islington (bot) <31488909+miss-isling...@users.noreply.github.com>
committer: erlend-aasland <erlend.aasl...@protonmail.com>
date: 2024-01-21T13:03:53Z
summary:
[3.11] gh-114384: Align sys.set_asyncgen_hooks signature in docs to reflect
implementation (GH-114385) (#114387)
(cherry picked from commit 38768e4cdd1c4b6e03702da8a94e1c22479d6ed3)
Co-authored-by: Nikita Sobolev <m...@sobolevn.me>
files:
M Doc/library/sys.rst
M Python/sysmodule.c
diff --git a/Doc/library/sys.rst b/Doc/library/sys.rst
index 6fbfbde4c77068..2a1e6fb1a9cf29 100644
--- a/Doc/library/sys.rst
+++ b/Doc/library/sys.rst
@@ -1606,7 +1606,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 d0941e8cfebeb6..89f454cdc53fed 100644
--- a/Python/sysmodule.c
+++ b/Python/sysmodule.c
@@ -1282,7 +1282,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."
);
_______________________________________________
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
