diff options
| author | Antonio Cuni <anto.cuni@gmail.com> | 2021-01-06 11:38:26 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-01-06 11:38:26 (GMT) |
| commit | 315fc52db17b19fe30aa9193f26adf69e18d8844 (patch) | |
| tree | 90a8795e94974c667c306f8e508c4df674bfc7b8 /Doc/c-api/iter.rst | |
| parent | 1a9f51ed12feb4d95ad6d0faf610a030c05b9f5e (diff) | |
| download | cpython-315fc52db17b19fe30aa9193f26adf69e18d8844.zip cpython-315fc52db17b19fe30aa9193f26adf69e18d8844.tar.gz cpython-315fc52db17b19fe30aa9193f26adf69e18d8844.tar.bz2 | |
bpo-42528: Improve the docs of most Py*_Check{,Exact} API calls (GH-23602)
I think that none of these API calls can fail, but only few of them are
documented as such. Add the sentence "This function always succeeds" (which is
the same already used e.g. by PyNumber_Check) to all of them.
Diffstat (limited to 'Doc/c-api/iter.rst')
| -rw-r--r-- | Doc/c-api/iter.rst | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/Doc/c-api/iter.rst b/Doc/c-api/iter.rst index 68df6f6..74fb557 100644 --- a/Doc/c-api/iter.rst +++ b/Doc/c-api/iter.rst @@ -9,7 +9,8 @@ There are two functions specifically for working with iterators. .. c:function:: int PyIter_Check(PyObject *o) - Return true if the object *o* supports the iterator protocol. + Return true if the object *o* supports the iterator protocol. This + function always succeeds. .. c:function:: PyObject* PyIter_Next(PyObject *o) |