gh-114384: Align sys.set_asyncgen_hooks signature in docs to reflect implementation (#114385)

sobolevn · web-flow · commit 38768e4cdd1c · 2024-01-21T13:49:49.000+01:00
diff --git a/Doc/library/sys.rst b/Doc/library/sys.rst
@@ -1655,7 +1655,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
@@ -1420,7 +1420,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."
 );

Original file line number	Diff line number	Diff line change
`@@ -1420,7 +1420,7 @@ sys_set_asyncgen_hooks(PyObject self, PyObject args, PyObject *kw)`
`1420`	`1420`	`}`
`1421`	`1421`
`1422`	`1422`	`PyDoc_STRVAR(set_asyncgen_hooks_doc,`
`1423`		`-"set_asyncgen_hooks(* [, firstiter] [, finalizer])\n\`
	`1423`	`+"set_asyncgen_hooks([firstiter] [, finalizer])\n\`
`1424`	`1424`	`\n\`
`1425`	`1425`	`Set a finalizer for async generators objects."`
`1426`	`1426`	`);`