]> git.ipfire.org Git - thirdparty/Python/cpython.git/commit
bpo-42528: Improve the docs of most Py*_Check{,Exact} API calls (GH-23602)
authorAntonio Cuni <anto.cuni@gmail.com>
Wed, 6 Jan 2021 11:38:26 +0000 (12:38 +0100)
committerGitHub <noreply@github.com>
Wed, 6 Jan 2021 11:38:26 +0000 (12:38 +0100)
commit315fc52db17b19fe30aa9193f26adf69e18d8844
tree90a8795e94974c667c306f8e508c4df674bfc7b8
parent1a9f51ed12feb4d95ad6d0faf610a030c05b9f5e
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.
26 files changed:
Doc/c-api/bool.rst
Doc/c-api/bytearray.rst
Doc/c-api/bytes.rst
Doc/c-api/capsule.rst
Doc/c-api/cell.rst
Doc/c-api/code.rst
Doc/c-api/complex.rst
Doc/c-api/coro.rst
Doc/c-api/datetime.rst
Doc/c-api/dict.rst
Doc/c-api/float.rst
Doc/c-api/function.rst
Doc/c-api/gen.rst
Doc/c-api/iter.rst
Doc/c-api/iterator.rst
Doc/c-api/list.rst
Doc/c-api/long.rst
Doc/c-api/memoryview.rst
Doc/c-api/method.rst
Doc/c-api/module.rst
Doc/c-api/set.rst
Doc/c-api/slice.rst
Doc/c-api/tuple.rst
Doc/c-api/type.rst
Doc/c-api/unicode.rst
Doc/c-api/weakref.rst