]> git.ipfire.org Git - thirdparty/Python/cpython.git/commit
bpo-42528: Improve the docs of most Py*_Check{,Exact} API calls (GH-23602) (GH-24139)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Wed, 6 Jan 2021 12:54:18 +0000 (04:54 -0800)
committerGitHub <noreply@github.com>
Wed, 6 Jan 2021 12:54:18 +0000 (13:54 +0100)
commitfaf49573963921033c608b4d2f398309d9f0d2b5
tree92cc19ba1878beb393127731cb1b499fa35feca1
parenta3ca6747f50efa2fe59caf516a26b0fd1912b8e8
bpo-42528: Improve the docs of most Py*_Check{,Exact} API calls (GH-23602) (GH-24139)

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.
(cherry picked from commit 315fc52db17b19fe30aa9193f26adf69e18d8844)

Co-authored-by: Antonio Cuni <anto.cuni@gmail.com>
Co-authored-by: Antonio Cuni <anto.cuni@gmail.com>
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