summaryrefslogtreecommitdiffstats
path: root/Doc/c-api/iter.rst
diff options
context:
space:
mode:
authorYury Selivanov <yury@edgedb.com>2021-09-07 10:52:30 (GMT)
committerGitHub <noreply@github.com>2021-09-07 10:52:30 (GMT)
commit2c3474a637949aa6f2f7e15f9764c2dfc49cdba1 (patch)
treed19d7d6dbdeb410d2413711b9610bc4344fd12ef /Doc/c-api/iter.rst
parenteb254b43d2916ef8c0e9ca815fe047411d848aae (diff)
downloadcpython-2c3474a637949aa6f2f7e15f9764c2dfc49cdba1.zip
cpython-2c3474a637949aa6f2f7e15f9764c2dfc49cdba1.tar.gz
cpython-2c3474a637949aa6f2f7e15f9764c2dfc49cdba1.tar.bz2
bpo-45123: PyAiter_Check and PyObject_GetAiter fix & rename. (GH-28194)
Fix PyAiter_Check to only check for the `__anext__` presense (not for `__aiter__`). Rename `PyAiter_Check()` to `PyAIter_Check()`, `PyObject_GetAiter()` -> `PyObject_GetAIter()`. Co-authored-by: Pablo Galindo Salgado <Pablogsal@gmail.com>
Diffstat (limited to 'Doc/c-api/iter.rst')
-rw-r--r--Doc/c-api/iter.rst2
1 files changed, 1 insertions, 1 deletions
diff --git a/Doc/c-api/iter.rst b/Doc/c-api/iter.rst
index 63290e0..f7106f4 100644
--- a/Doc/c-api/iter.rst
+++ b/Doc/c-api/iter.rst
@@ -12,7 +12,7 @@ There are two functions specifically for working with iterators.
Return non-zero if the object *o* supports the iterator protocol, and ``0``
otherwise. This function always succeeds.
-.. c:function:: int PyAiter_Check(PyObject *o)
+.. c:function:: int PyAIter_Check(PyObject *o)
Returns non-zero if the object 'obj' provides :class:`AsyncIterator`
protocols, and ``0`` otherwise. This function always succeeds.