summaryrefslogtreecommitdiffstats
path: root/Python/bltinmodule.c
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/bltinmodule.c
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/bltinmodule.c')
-rw-r--r--Python/bltinmodule.c7
1 files changed, 5 insertions, 2 deletions
diff --git a/Python/bltinmodule.c b/Python/bltinmodule.c
index 66a74cb..66c5fba 100644
--- a/Python/bltinmodule.c
+++ b/Python/bltinmodule.c
@@ -1631,13 +1631,16 @@ anext as builtin_anext
default: object = NULL
/
-Return the next item from the async iterator.
+async anext(aiterator[, default])
+
+Return the next item from the async iterator. If default is given and the async
+iterator is exhausted, it is returned instead of raising StopAsyncIteration.
[clinic start generated code]*/
static PyObject *
builtin_anext_impl(PyObject *module, PyObject *aiterator,
PyObject *default_value)
-/*[clinic end generated code: output=f02c060c163a81fa input=699d11f4e38eca24]*/
+/*[clinic end generated code: output=f02c060c163a81fa input=8f63f4f78590bb4c]*/
{
PyTypeObject *t;
PyObject *awaitable;