Miss Islington (bot) 3fe97357ce

[3.14] gh-141004: Reorganize and reword the 'Useful macros' section (GH-144471) (GH-144541) ...

- 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

(cherry picked from commit f85e1170d2b22d2ee42cd568144e0c9f57b0db67)

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

2026-02-06 12:50:06 +01:00

..

abstract.rst

…

allocation.rst

[3.14] gh-141004: Document deprecated aliases for memory allocation (GH-141146) (GH-141288)

2025-11-09 15:12:52 +00:00

apiabiversion.rst

[3.14] gh-143578: Restore note about patchlevel.h (GH-143596) (#143725)

2026-01-12 13:49:43 +02:00

arg.rst

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

2025-10-24 12:24:26 +00:00

bool.rst

…

buffer.rst

[3.14] gh-141004: Document PyBUF_WRITEABLE (GH-141255) (GH-141261)

2025-11-08 17:36:00 +00:00

bytearray.rst

…

bytes.rst

[3.14] gh-141004: Document PyBytes_Repr and PyBytes_DecodeEscape (GH-141407) (GH-141440)

2025-11-12 02:06:36 +00:00

call.rst

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

2026-01-14 11:01:37 +01:00

capsule.rst

[3.14] gh-141004: Document PyCapsule_Type (GH-141079) (GH-141199)

2025-11-07 14:16:43 +00:00

cell.rst

[3.14] Fix minor typos and wording in C API docs (GH-140955) (#140966)

2025-11-04 09:46:08 +02:00

code.rst

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

2026-01-14 11:01:37 +01:00

codec.rst

[3.14] gh-141004: Document Py_hexdigits (GH-141059) (GH-141138)

2025-11-06 13:56:41 +00:00

complex.rst

…

concrete.rst

[3.14] gh-141004: Document the PyPickleBuffer_* C API (GH-141630) (GH-141632)

2025-11-16 18:56:41 +00:00

contextvars.rst

…

conversion.rst

[3.14] gh-141004: Mark up constants for PyOS_double_to_string (GH-143867) (GH-144146)

2026-01-22 13:30:14 +01:00

coro.rst

…

curses.rst

[3.14] gh-141004: document curses C API (GH-141254) (#141292)

2025-11-09 15:50:21 +00:00

datetime.rst

[3.14] gh-141004: Document missing PyDateTime* APIs (GH-141543) (GH-141791)

2025-11-20 13:54:48 +00:00

descriptor.rst

[3.14] gh-141004: Document descriptor and dict proxy type objects (GH-141803) (GH142147)

2025-12-01 15:57:31 +00:00

dict.rst

[3.14] gh-141004: Document descriptor and dict proxy type objects (GH-141803) (GH142147)

2025-12-01 15:57:31 +00:00

exceptions.rst

[3.14] gh-139653: Add PyUnstable_ThreadState_SetStackProtection() (GH-139668) (#141661)

2025-11-25 14:21:53 +01:00

extension-modules.rst

[3.14] Docs: Remove unnecessary trailing backslashes (GH-135781) (GH-135791)

2025-06-21 13:07:51 +00:00

file.rst

[3.14] gh-141004: Document several soft-deprecated C APIs (GH-141634) (GH-143837)

2026-01-14 13:25:57 +00:00

float.rst

[3.14] gh-141004: Document Py_HUGE_VAL/IS_FINITE/IS_INFINITE/IS_NAN (GH-141544) (#141698)

2025-11-18 14:32:44 +01:00

frame.rst

[3.14] gh-141004: Document missing frame APIs (GH-141189) (GH-141379)

2025-11-10 21:42:10 +00:00

function.rst

[3.14] gh-141004: Document PyFunction_SetKwDefaults (GH-141294) (GH-141304)

2025-11-09 17:55:09 +00:00

gcsupport.rst

[3.14] gh-123241: Document restrictions for tp_traverse implementations (gh-142272) (#142423)

2025-12-08 17:27:57 +00:00

gen.rst

[3.14] gh-141004: Document several soft-deprecated C APIs (GH-141634) (GH-143837)

2026-01-14 13:25:57 +00:00

hash.rst

[3.14] gh-141004: correctly document Py_HASH_* and PyHASH_* as hash_info attributes (GH-141233) (#141234)

2025-11-08 12:28:01 +00:00

import.rst

[3.14] gh-141004: Document PyImport_Inittab (GH-141844) (GH-141915)

2025-11-24 12:16:31 -05:00

index.rst

[3.14] gh-134160: Split extension module init from PyModule docs; emphasize multi-phase init (GH-135126) (#135470)

2025-06-16 18:01:09 +03:00

init_config.rst

[3.14] Fix minor typos and wording in C API docs (GH-140955) (#140966)

2025-11-04 09:46:08 +02:00

init.rst

Python 3.14.1

2025-12-02 14:51:37 +02:00

intro.rst

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

2026-02-06 12:50:06 +01:00

iter.rst

…

iterator.rst

[3.14] gh-141004: Document PyODict* APIs (GH-141136) (GH-141677)

2025-11-17 19:46:23 +00:00

lifecycle.dot

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

2025-05-20 19:11:01 +02:00

lifecycle.dot.css

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

2025-05-20 19:11:01 +02:00

lifecycle.dot.pdf

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

2025-05-20 19:11:01 +02:00

lifecycle.dot.svg

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

2025-05-20 19:11:01 +02:00

lifecycle.rst

[3.14] gh-75459: versionadded for PyObject_CallFinalizer*() API (GH-143982) (#144026)

2026-01-20 12:06:21 +02:00

list.rst

…

long.rst

[3.14] gh-143834: Fix PyLong_AsNativeBytes docs for negative number padding (GH-143840) (GH-143854)

2026-01-15 09:34:13 +01:00

mapping.rst

[3.14] Fix minor typos and wording in C API docs (GH-140955) (#140966)

2025-11-04 09:46:08 +02:00

marshal.rst

[3.14] Fix minor typos and wording in C API docs (GH-140955) (#140966)

2025-11-04 09:46:08 +02:00

memory.rst

[3.14] gh-141004: Mark up docs of old PyMem macros (GH-143783) (GH-143864)

2026-01-22 11:52:05 +01:00

memoryview.rst

[3.14] gh-141004: Document PyMemoryView_Type (GH-141034) (GH-141054)

2025-11-05 16:51:34 +00:00

method.rst

…

module.rst

[3.14] gh-144257: document return values of PyModule_SetDocString (GH-144258) (GH-144263)

2026-01-27 07:21:38 +00:00

monitoring.rst

[3.14] Fix minor typos and wording in C API docs (GH-140955) (#140966)

2025-11-04 09:46:08 +02:00

none.rst

…

number.rst

…

object.rst

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

2026-02-01 21:01:43 -05:00

objimpl.rst

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

2025-05-20 19:11:01 +02:00

perfmaps.rst

…

picklebuffer.rst

[3.14] gh-141004: Document the PyPickleBuffer_* C API (GH-141630) (GH-141632)

2025-11-16 18:56:41 +00:00

refcounting.rst

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

2026-02-01 21:01:43 -05:00

reflection.rst

…

sequence.rst

…

set.rst

[3.14] gh-141004: Document several soft-deprecated C APIs (GH-141634) (GH-143837)

2026-01-14 13:25:57 +00:00

slice.rst

…

stable.rst

[3.14] gh-134830: Fix reference in Doc/extending/windows.rst (GH-134831) (GH-135058)

2025-06-03 06:33:04 +00:00

structures.rst

[3.14] gh-138189: Link references to type slots (GH-141410) (GH-141718)

2025-11-19 10:30:11 +01:00

sys.rst

[3.14] gh-141004: Document PyOS_InterruptOccurred (GH-141526) (GH-141549)

2025-11-14 11:26:37 +00:00

time.rst

…

tuple.rst

[3.14] Fix minor typos and wording in C API docs (GH-140955) (#140966)

2025-11-04 09:46:08 +02:00

type.rst

[3.14] gh-141729: Doc PyTypeObject.tp_vectorcall grammar fix (GH-141730) (#141815)

2025-11-21 23:14:43 +03:00

typehints.rst

…

typeobj.rst

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

2026-01-14 11:01:37 +01:00

unicode.rst

[3.14] gh-141004: Document PyUnicode_IS_COMPACT and PyUnicode_IS_COMPACT_ASCII macros (GH-143494) (GH-143785)

2026-01-13 19:06:23 +01:00

utilities.rst

…

veryhigh.rst

[3.14] gh-141004: Document stack effect C APIs (GH-141843) (GH-141916)

2025-11-24 17:24:41 +00:00

weakref.rst

[3.14] gh-141004: Document PyType_SUPPORTS_WEAKREFS (GH-141408) (GH-141470)

2025-11-12 16:44:17 +00:00