summaryrefslogtreecommitdiffstats
path: root/Python/clinic/bltinmodule.c.h
diff options
context:
space:
mode:
authorErik Welch <erik.n.welch@gmail.com>2021-06-22 21:00:51 (GMT)
committerGitHub <noreply@github.com>2021-06-22 21:00:51 (GMT)
commit6af4e6b266cb19d646ad7e4051fc7974c3096d23 (patch)
tree7dd835f4d8388c0d5e496268c167166512184159 /Python/clinic/bltinmodule.c.h
parenta6b47de07a304eaa37a1c5554ed00a3ec91f8407 (diff)
downloadcpython-6af4e6b266cb19d646ad7e4051fc7974c3096d23.zip
cpython-6af4e6b266cb19d646ad7e4051fc7974c3096d23.tar.gz
cpython-6af4e6b266cb19d646ad7e4051fc7974c3096d23.tar.bz2
bpo-43918: document signature and default argument of `anext` builtin (#25551)
Co-authored-by: Dennis Sweeney <36520290+sweeneyde@users.noreply.github.com>
Diffstat (limited to 'Python/clinic/bltinmodule.c.h')
-rw-r--r--Python/clinic/bltinmodule.c.h7
1 files changed, 5 insertions, 2 deletions
diff --git a/Python/clinic/bltinmodule.c.h b/Python/clinic/bltinmodule.c.h
index 545f5b5..4ea5876 100644
--- a/Python/clinic/bltinmodule.c.h
+++ b/Python/clinic/bltinmodule.c.h
@@ -543,7 +543,10 @@ PyDoc_STRVAR(builtin_anext__doc__,
"anext($module, aiterator, default=<unrepresentable>, /)\n"
"--\n"
"\n"
-"Return the next item from the async iterator.");
+"async anext(aiterator[, default])\n"
+"\n"
+"Return the next item from the async iterator. If default is given and the async\n"
+"iterator is exhausted, it is returned instead of raising StopAsyncIteration.");
#define BUILTIN_ANEXT_METHODDEF \
{"anext", (PyCFunction)(void(*)(void))builtin_anext, METH_FASTCALL, builtin_anext__doc__},
@@ -874,4 +877,4 @@ builtin_issubclass(PyObject *module, PyObject *const *args, Py_ssize_t nargs)
exit:
return return_value;
}
-/*[clinic end generated code: output=da9ae459e9233259 input=a9049054013a1b77]*/
+/*[clinic end generated code: output=e1d8057298b5de61 input=a9049054013a1b77]*/