Petr Viktorin f85e1170d2 gh-141004: Reorganize and reword the 'Useful macros' section (GH-144471) ...

- Group the macros
- Roughly order them to put the most important ones first
- Add expansions where it makes sense; especially if there's
  an equivalent in modern C or a common compiler

Co-authored-by: Victor Stinner <vstinner@python.org>
Co-authored-by: Peter Bierma <zintensitydev@gmail.com>

2026-02-06 11:55:11 +01:00

..

abstract.rst

…

allocation.rst

gh-141004: Document deprecated aliases for memory allocation (GH-141146)

2025-11-09 10:06:38 -05:00

apiabiversion.rst

gh-143578: Restore note about patchlevel.h (#143596)

2026-01-12 11:21:14 +00:00

arg.rst

Docs: Fix a grammatical error in Doc/c-api/arg.rst (GH-140525)

2025-10-24 08:17:52 -04:00

bool.rst

…

buffer.rst

gh-141004: Document PyBUF_WRITEABLE (GH-141255)

2025-11-08 12:29:31 -05:00

bytearray.rst

Python 3.14.0a5

2025-02-11 19:16:29 +02:00

bytes.rst

gh-141004: Document PyBytes_Repr and PyBytes_DecodeEscape (GH-141407)

2025-11-11 15:32:54 -05:00

call.rst

gh-141004: Document old provisional names for vectorcall/code API (GH-143568)

2026-01-14 10:54:45 +01:00

capsule.rst

gh-141004: Document PyCapsule_Type (GH-141079)

2025-11-07 09:09:38 -05:00

cell.rst

Fix minor typos and wording in C API docs (#140955)

2025-11-03 22:04:46 +02:00

code.rst

gh-141004: Document old provisional names for vectorcall/code API (GH-143568)

2026-01-14 10:54:45 +01:00

codec.rst

gh-141004: Document Py_hexdigits (GH-141059)

2025-11-06 08:48:42 -05:00

complex.rst

Fix minor typos and wording in C API docs (#140955)

2025-11-03 22:04:46 +02:00

concrete.rst

gh-141004: Document the PyPickleBuffer_* C API (GH-141630)

2025-11-16 13:50:54 -05:00

contextvars.rst

gh-124872: Replace enter/exit events with "switched" (#125532)

2024-10-16 13:53:21 +02:00

conversion.rst

gh-141004: Mark up constants for PyOS_double_to_string (GH-143867)

2026-01-22 11:53:17 +01:00

coro.rst

…

curses.rst

gh-141004: document curses C API (#141254)

2025-11-09 15:44:26 +00:00

datetime.rst

gh-141004: Document missing PyDateTime* APIs (GH-141543)

2025-11-20 08:48:10 -05:00

descriptor.rst

gh-141004: Document PyException_HEAD and PyDescr_COMMON (GH-143896)

2026-01-17 10:39:29 -05:00

dict.rst

gh-141004: Document descriptor and dict proxy type objects (GH-141803)

2025-12-01 15:51:50 +00:00

exceptions.rst

gh-141004: Document PyException_HEAD and PyDescr_COMMON (GH-143896)

2026-01-17 10:39:29 -05:00

extension-modules.rst

Python 3.15.0a3

2025-12-16 14:26:12 +02:00

file.rst

gh-141004: Document several soft-deprecated C APIs (GH-141634)

2026-01-14 08:20:33 -05:00

float.rst

gh-141004: Document Py_HUGE_VAL/IS_FINITE/IS_INFINITE/IS_NAN (#141544)

2025-11-18 10:17:37 +01:00

frame.rst

gh-141004: Document missing frame APIs (GH-141189)

2025-11-10 21:35:47 +00:00

function.rst

gh-141004: Document PyFunction_SetKwDefaults (GH-141294)

2025-11-09 12:49:17 -05:00

gcsupport.rst

gh-123241: Document restrictions for tp_traverse implementations (gh-142272)

2025-12-08 12:22:13 -05:00

gen.rst

gh-141004: Document several soft-deprecated C APIs (GH-141634)

2026-01-14 08:20:33 -05:00

hash.rst

gh-141004: correctly document Py_HASH_* and PyHASH_* as hash_info attributes (#141233)

2025-11-08 12:22:02 +00:00

import.rst

GH-65961: Stop setting __cached__ on modules (GH-142165)

2025-12-11 11:44:46 -08:00

index.rst

gh-134160: Split extension module init from PyModule docs; emphasize multi-phase init (GH-135126)

2025-06-13 16:39:35 +02:00

init_config.rst

Fix minor typos and wording in C API docs (#140955)

2025-11-03 22:04:46 +02:00

init.rst

gh-140550: PEP 793 reference documentation (GH-141197)

2025-11-26 12:50:03 +00:00

intro.rst

gh-141004: Reorganize and reword the 'Useful macros' section (GH-144471)

2026-02-06 11:55:11 +01:00

iter.rst

Fix typo in PyIter_Send docs (#140336)

2025-10-20 14:23:57 +05:30

iterator.rst

gh-141004: Document PyODict* APIs (GH-141136)

2025-11-17 14:40:47 -05:00

lifecycle.dot

gh-75459: Doc: C API: Improve object life cycle documentation (GH-125962)

2025-05-20 14:25:50 +02:00

lifecycle.dot.css

gh-75459: Doc: C API: Improve object life cycle documentation (GH-125962)

2025-05-20 14:25:50 +02:00

lifecycle.dot.pdf

gh-75459: Doc: C API: Improve object life cycle documentation (GH-125962)

2025-05-20 14:25:50 +02:00

lifecycle.dot.svg

gh-75459: Doc: C API: Improve object life cycle documentation (GH-125962)

2025-05-20 14:25:50 +02:00

lifecycle.rst

gh-75459: versionadded for PyObject_CallFinalizer*() API (GH-143982)

2026-01-19 11:22:16 +01:00

list.rst

gh-121403: Add notes for PyList_GetXXX APIs about the need for init (gh-121626)

2024-07-16 10:16:41 +09:00

long.rst

gh-143869: Add PEP 757 functions to the limited API (#143906)

2026-01-21 14:47:14 +01:00

mapping.rst

Fix minor typos and wording in C API docs (#140955)

2025-11-03 22:04:46 +02:00

marshal.rst

Fix minor typos and wording in C API docs (#140955)

2025-11-03 22:04:46 +02:00

memory.rst

gh-144319: Add huge pages support for pymalloc (#144320)

2026-01-29 12:26:11 +00:00

memoryview.rst

gh-141004: Document PyMemoryView_Type (GH-141034)

2025-11-05 11:45:13 -05:00

method.rst

…

module.rst

gh-143883: Use named parameters in PyModExport-related declarations & docs (GH-143884)

2026-01-27 10:28:28 +00:00

monitoring.rst

Fix minor typos and wording in C API docs (#140955)

2025-11-03 22:04:46 +02:00

none.rst

…

number.rst

gh-121905: Consistently use "floating-point" instead of "floating point" (GH-121907)

2024-07-19 08:06:02 +00:00

object.rst

gh-144277: Fix usage of free-threaded terminology in the documentation (GH-144333)

2026-02-01 20:39:26 -05:00

objimpl.rst

gh-75459: Doc: C API: Improve object life cycle documentation (GH-125962)

2025-05-20 14:25:50 +02:00

perfmaps.rst

gh-136459: Add perf trampoline support for macOS (#136461)

2025-07-22 16:47:24 +01:00

picklebuffer.rst

gh-141004: Document the PyPickleBuffer_* C API (GH-141630)

2025-11-16 13:50:54 -05:00

refcounting.rst

gh-144277: Fix usage of free-threaded terminology in the documentation (GH-144333)

2026-02-01 20:39:26 -05:00

reflection.rst

gh-127989: C API: Refer to "attached thread states" instead of the GIL (GH-127990)

2025-03-20 13:06:59 +01:00

sequence.rst

gh-127896: Add missing documentation of PySequence_In (GH-127979)

2024-12-16 14:56:04 +01:00

set.rst

gh-141004: Document several soft-deprecated C APIs (GH-141634)

2026-01-14 08:20:33 -05:00

slice.rst

gh-130214: Document PyEllipsis_Type (GH-130215)

2025-02-17 13:56:33 +01:00

stable.rst

Fix minor typos and wording in C API docs (#140955)

2025-11-03 22:04:46 +02:00

structures.rst

gh-140550: PEP 793 reference documentation (GH-141197)

2025-11-26 12:50:03 +00:00

sys.rst

gh-141004: Document PyOS_InterruptOccurred (GH-141526)

2025-11-14 06:20:36 -05:00

time.rst

gh-127989: C API: Refer to "attached thread states" instead of the GIL (GH-127990)

2025-03-20 13:06:59 +01:00

tuple.rst

Clarify that PyStructSequence is different from collections.namedtuple (#142626)

2025-12-16 13:38:11 +02:00

type.rst

Python 3.15.0a3

2025-12-16 14:26:12 +02:00

typehints.rst

…

typeobj.rst

gh-141004: Document old provisional names for vectorcall/code API (GH-143568)

2026-01-14 10:54:45 +01:00

unicode.rst

gh-141004: Document PyUnicode_IS_COMPACT and PyUnicode_IS_COMPACT_ASCII macros (GH-143494)

2026-01-12 13:59:59 +01:00

utilities.rst

gh-110850: Add PyTime_t C API (GH-115215)

2024-02-12 18:13:10 +01:00

veryhigh.rst

gh-141004: Document stack effect C APIs (GH-141843)

2025-11-24 12:18:50 -05:00

weakref.rst

gh-141004: Document PyType_SUPPORTS_WEAKREFS (GH-141408)

2025-11-12 11:38:17 -05:00