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/dict.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/dict.rst')
| -rw-r--r-- | Doc/c-api/dict.rst | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/Doc/c-api/dict.rst b/Doc/c-api/dict.rst index 8e0d684..d257c9b 100644 --- a/Doc/c-api/dict.rst +++ b/Doc/c-api/dict.rst @@ -22,13 +22,13 @@ Dictionary Objects .. c:function:: int PyDict_Check(PyObject *p) Return true if *p* is a dict object or an instance of a subtype of the dict - type. + type. This function always succeeds. .. c:function:: int PyDict_CheckExact(PyObject *p) Return true if *p* is a dict object, but not an instance of a subtype of - the dict type. + the dict type. This function always succeeds. .. c:function:: PyObject* PyDict_New() |