mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-08-03 08:34:29 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 6

bpo-42528: Improve the docs of most Py*_Check{,Exact} API calls (GH-23602)

Browse source 
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.
This commit is contained in:
Antonio Cuni 2021-01-06 12:38:26 +01:00 • committed by GitHub
parent 1a9f51ed12
commit 315fc52db1
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
26 changed files with 74 additions and 52 deletions
Download patch file Download diff file Expand all files Collapse all files

4
Doc/c-api/float.rst
View file

@ -22,13 +22,13 @@ Floating Point Objects
.. c:function:: int PyFloat_Check(PyObject *p)
Return true if its argument is a :c:type:`PyFloatObject` or a subtype of
:c:type:`PyFloatObject`.
:c:type:`PyFloatObject`. This function always succeeds.
.. c:function:: int PyFloat_CheckExact(PyObject *p)
Return true if its argument is a :c:type:`PyFloatObject`, but not a subtype of
:c:type:`PyFloatObject`.
:c:type:`PyFloatObject`. This function always succeeds.
.. c:function:: PyObject* PyFloat_FromString(PyObject *str)