cpython/Doc/c-api
Antonio Cuni 315fc52db1
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.
2021-01-06 12:38:26 +01:00
..
abstract.rst bpo-41103: Remove old buffer protocol support (#21117) 2020-06-26 08:07:22 +09:00
allocation.rst bpo-37432: Doc: Fix signature of PyObject_Del() (GH-14430) 2019-06-28 18:02:56 +09:00
apiabiversion.rst Doc: Replace the deprecated highlightlang directive by highlight. (#13377) 2019-05-17 15:25:34 +05:30
arg.rst bpo-42294: Add borrowed/strong reference to doc glossary (GH-23206) 2020-11-09 13:40:47 +01:00
bool.rst bpo-42528: Improve the docs of most Py*_Check{,Exact} API calls (GH-23602) 2021-01-06 12:38:26 +01:00
buffer.rst bpo-40204, doc: Fix syntax of C variables (GH-21846) 2020-08-13 22:11:50 +02:00
bytearray.rst bpo-42528: Improve the docs of most Py*_Check{,Exact} API calls (GH-23602) 2021-01-06 12:38:26 +01:00
bytes.rst bpo-42528: Improve the docs of most Py*_Check{,Exact} API calls (GH-23602) 2021-01-06 12:38:26 +01:00
call.rst bpo-40204, doc: Fix syntax of C variables (GH-21846) 2020-08-13 22:11:50 +02:00
capsule.rst bpo-42528: Improve the docs of most Py*_Check{,Exact} API calls (GH-23602) 2021-01-06 12:38:26 +01:00
cell.rst bpo-42528: Improve the docs of most Py*_Check{,Exact} API calls (GH-23602) 2021-01-06 12:38:26 +01:00
code.rst bpo-42528: Improve the docs of most Py*_Check{,Exact} API calls (GH-23602) 2021-01-06 12:38:26 +01:00
codec.rst bpo-41842: Add codecs.unregister() function (GH-22360) 2020-09-28 23:41:11 +02:00
complex.rst bpo-42528: Improve the docs of most Py*_Check{,Exact} API calls (GH-23602) 2021-01-06 12:38:26 +01:00
concrete.rst bpo-41324 Add a minimal decimal capsule API (#21519) 2020-08-10 16:32:21 +02:00
contextvars.rst bpo-40428: Remove references to Py*_ClearFreeList in the docs (GH-19783) 2020-04-29 04:41:56 +02:00
conversion.rst bpo-36020: Require vsnprintf() to build Python (GH-20899) 2020-06-16 00:54:44 +02:00
coro.rst bpo-42528: Improve the docs of most Py*_Check{,Exact} API calls (GH-23602) 2021-01-06 12:38:26 +01:00
datetime.rst bpo-42528: Improve the docs of most Py*_Check{,Exact} API calls (GH-23602) 2021-01-06 12:38:26 +01:00
decimal.rst Fix .. code-block :: directives in decimal.rst (GH-22571) 2020-10-11 19:26:50 +01:00
descriptor.rst Doc: Replace the deprecated highlightlang directive by highlight. (#13377) 2019-05-17 15:25:34 +05:30
dict.rst bpo-42528: Improve the docs of most Py*_Check{,Exact} API calls (GH-23602) 2021-01-06 12:38:26 +01:00
exceptions.rst bpo-42236: Enhance init and encoding documentation (GH-23109) 2020-11-02 16:49:54 +01:00
file.rst bpo-41192: Add documentation of undocumented audit events (GH-21308) 2020-10-20 15:23:15 -04:00
float.rst bpo-42528: Improve the docs of most Py*_Check{,Exact} API calls (GH-23602) 2021-01-06 12:38:26 +01:00
function.rst bpo-42528: Improve the docs of most Py*_Check{,Exact} API calls (GH-23602) 2021-01-06 12:38:26 +01:00
gcsupport.rst bpo-40170: Convert PyObject_IS_GC() macro to a function (GH-19464) 2020-04-14 20:11:20 +02:00
gen.rst bpo-42528: Improve the docs of most Py*_Check{,Exact} API calls (GH-23602) 2021-01-06 12:38:26 +01:00
import.rst bpo-38600: NULL -> `NULL`. (GH-17001) 2019-10-30 21:37:16 +02:00
index.rst bpo-36763: Implement the PEP 587 (GH-13592) 2019-05-27 16:39:22 +02:00
init.rst bpo-42260: Fix _PyConfig_Read() if compute_path_config=0 (GH-23220) 2020-11-10 21:10:22 +01:00
init_config.rst bpo-42260: Fix _PyConfig_Read() if compute_path_config=0 (GH-23220) 2020-11-10 21:10:22 +01:00
intro.rst bpo-42294: Add borrowed/strong reference to doc glossary (GH-23206) 2020-11-09 13:40:47 +01:00
iter.rst bpo-42528: Improve the docs of most Py*_Check{,Exact} API calls (GH-23602) 2021-01-06 12:38:26 +01:00
iterator.rst bpo-42528: Improve the docs of most Py*_Check{,Exact} API calls (GH-23602) 2021-01-06 12:38:26 +01:00
list.rst bpo-42528: Improve the docs of most Py*_Check{,Exact} API calls (GH-23602) 2021-01-06 12:38:26 +01:00
long.rst bpo-42528: Improve the docs of most Py*_Check{,Exact} API calls (GH-23602) 2021-01-06 12:38:26 +01:00
mapping.rst bpo-39153: Clarify C API *SetItem refcounting semantics (GH-18220) 2020-01-29 21:20:53 +10:00
marshal.rst bpo-40204, doc: Fix syntax of C variables (GH-21846) 2020-08-13 22:11:50 +02:00
memory.rst bpo-40204, doc: Fix syntax of C variables (GH-21846) 2020-08-13 22:11:50 +02:00
memoryview.rst bpo-42528: Improve the docs of most Py*_Check{,Exact} API calls (GH-23602) 2021-01-06 12:38:26 +01:00
method.rst bpo-42528: Improve the docs of most Py*_Check{,Exact} API calls (GH-23602) 2021-01-06 12:38:26 +01:00
module.rst bpo-42528: Improve the docs of most Py*_Check{,Exact} API calls (GH-23602) 2021-01-06 12:38:26 +01:00
none.rst Doc: Replace the deprecated highlightlang directive by highlight. (#13377) 2019-05-17 15:25:34 +05:30
number.rst bpo-40792: Make the result of PyNumber_Index() always having exact type int. (GH-20443) 2020-05-28 10:33:45 +03:00
object.rst bpo-40204, doc: Fix syntax of C variables (GH-21846) 2020-08-13 22:11:50 +02:00
objimpl.rst Doc: Replace the deprecated highlightlang directive by highlight. (#13377) 2019-05-17 15:25:34 +05:30
refcounting.rst bpo-42294: Add borrowed/strong reference to doc glossary (GH-23206) 2020-11-09 13:40:47 +01:00
reflection.rst bpo-42294: Add borrowed/strong reference to doc glossary (GH-23206) 2020-11-09 13:40:47 +01:00
sequence.rst bpo-38600: Change the mark up of NULL in the C API documentation. (GH-16950) 2019-10-30 12:03:20 +02:00
set.rst bpo-42528: Improve the docs of most Py*_Check{,Exact} API calls (GH-23602) 2021-01-06 12:38:26 +01:00
slice.rst bpo-42528: Improve the docs of most Py*_Check{,Exact} API calls (GH-23602) 2021-01-06 12:38:26 +01:00
stable.rst Doc: Replace the deprecated highlightlang directive by highlight. (#13377) 2019-05-17 15:25:34 +05:30
structures.rst bpo-39573: Convert Py_TYPE() and Py_SIZE() back to macros (GH-23366) 2020-11-18 18:48:06 +01:00
sys.rst bpo-42236: Enhance init and encoding documentation (GH-23109) 2020-11-02 16:49:54 +01:00
tuple.rst bpo-42528: Improve the docs of most Py*_Check{,Exact} API calls (GH-23602) 2021-01-06 12:38:26 +01:00
type.rst bpo-42528: Improve the docs of most Py*_Check{,Exact} API calls (GH-23602) 2021-01-06 12:38:26 +01:00
typeobj.rst bpo-42085: Add documentation for Py_TPFLAGS_HAVE_AM_SEND (GH-23374) 2020-11-18 10:58:38 -08:00
unicode.rst bpo-42528: Improve the docs of most Py*_Check{,Exact} API calls (GH-23602) 2021-01-06 12:38:26 +01:00
utilities.rst Doc: Replace the deprecated highlightlang directive by highlight. (#13377) 2019-05-17 15:25:34 +05:30
veryhigh.rst bpo-42236: Enhance init and encoding documentation (GH-23109) 2020-11-02 16:49:54 +01:00
weakref.rst bpo-42528: Improve the docs of most Py*_Check{,Exact} API calls (GH-23602) 2021-01-06 12:38:26 +01:00