3 people cd3395a8b1 [3.14] gh-132246: Add special buffer methods to C API Type Object docs (gh-132247) (gh-134426) ...

Two special methods, __buffer__ and __release_buffer__ were added to
Python 3.12 by PEP 688. The C API Type Object documentation for slots
includes `tp_as_buffer`, and sub-slots `bf_getbuffer`, `bf_releasebuffer`
but does not refer to the Python Data Model version of those. Add the
missing references.

(cherry picked from commit b529b60fc2)

Co-authored-by: Cody Maloney <[email protected]>

2025-05-21 16:33:35 +02:00

..

abstract.rst

gh-85275: Remove old buffer APIs (#105137)

2023-06-02 01:12:40 +00:00

allocation.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

apiabiversion.rst

gh-128629: Add Py_PACK_VERSION and Py_PACK_FULL_VERSION (GH-128630)

2025-01-09 11:10:28 +01:00

arg.rst

Python 3.14.0b1

2025-05-06 18:33:52 +03:00

bool.rst

gh-110481, doc: Add "immortal" term to the glossary (#112180)

2023-11-17 15:09:19 +01:00

buffer.rst

gh-132246: Add PEP 688 to C Buffer Protocol docs (#132249)

2025-04-08 10:43:27 -07:00

bytearray.rst

Python 3.14.0a5

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

bytes.rst

gh-121645: Fix typo in PyBytes_Join() doc (#123783)

2024-09-06 16:08:17 +02:00

call.rst

Add a version added note for PY_VECTORCALL_ARGUMENTS_OFFSET (#110963)

2023-10-23 19:00:52 +03:00

capsule.rst

gh-107298: Fix yet more Sphinx warnings in the C API doc (GH-107345)

2023-07-27 18:44:32 +03:00

cell.rst

gh-121533: Improve PyCell_[Get,Set] docs: mention the exceptions (#121534)

2024-07-09 18:47:35 +03:00

code.rst

gh-70870: Clarify dual usage of 'free variable' (#122545)

2024-10-08 07:52:12 +00:00

codec.rst

gh-107298: Fix doc references to undocumented modules (#107300)

2023-07-26 18:59:06 +02:00

complex.rst

gh-128813: hide mixed-mode functions for complex arithmetic from C-API (#131703)

2025-04-22 14:18:18 +02:00

concrete.rst

GH-97950: Use new-style index directive ('object') (#104158)

2023-05-04 13:04:41 +03:00

contextvars.rst

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

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

conversion.rst

gh-120026: soft deprecate Py_HUGE_VAL macro (#120027)

2024-11-01 22:04:31 +00:00

coro.rst

…

datetime.rst

gh-123517: Remove unnecessary `:meth:` parentheses (#123518)

2024-09-01 05:59:42 +01:00

descriptor.rst

bpo-40170: Convert PyDescr_IsData() to static inline function (GH-24535)

2021-02-16 08:50:00 +01:00

dict.rst

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

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

exceptions.rst

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

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

file.rst

gh-115172: Fix explicit index extries for the C API (GH-115173)

2024-02-11 12:23:30 +02:00

float.rst

gh-130317: Fix test_pack_unpack_roundtrip() and add docs (#133204)

2025-05-01 16:20:36 +02:00

frame.rst

gh-118915: C API: Document frame locals proxies. (#127720)

2024-12-11 17:28:44 +01:00

function.rst

gh-130169: Fix broken list markup in Doc/c-api/function.rst (#130174)

2025-02-16 13:55:31 +03:00

gcsupport.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

gen.rst

…

hash.rst

gh-122854: Add Py_HashBuffer() function (#122855)

2024-08-30 15:42:27 +00:00

import.rst

gh-128911: Add PyImport_ImportModuleAttr() function (#128912)

2025-01-30 11:17:29 +00:00

index.rst

gh-111997: C-API for signalling monitoring events (#116413)

2024-05-04 08:23:50 +00:00

init_config.rst

Python 3.14.0b1

2025-05-06 18:33:52 +03:00

init.rst

[3.14] Docs: C API: Improve documentation around non-Python threads with subinterpreters (GH-131087) (GH-134130)

2025-05-17 09:04:42 +00:00

intro.rst

Fix a grammar error in the Py_ALWAYS_INLINE doc (#129304)

2025-04-24 17:20:48 +03:00

iter.rst

gh-105201: Add PyIter_NextItem() (#122331)

2024-08-08 00:47:15 +02:00

iterator.rst

gh-107298: Fix Sphinx warnings in the C API doc (#107302)

2023-07-27 01:41:15 +02: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: Doc: C API: Improve object life cycle documentation (GH-125962) (GH-134344)

2025-05-20 19:11:01 +02: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-102471: Change PyLongWriter_Discard(NULL) to do nothing (#129339)

2025-01-27 10:51:16 +00:00

mapping.rst

gh-108511: Add C API functions which do not silently ignore errors (GH-109025)

2023-09-17 14:23:31 +03:00

marshal.rst

gh-125063: marshal: Add version 5, improve documentation (GH-126829)

2024-11-15 13:48:57 +01:00

memory.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

memoryview.rst

gh-101100: Fix sphinx warnings in Doc/c-api/memoryview.rst (GH-114669)

2024-01-29 11:56:11 +02:00

method.rst

gh-107091: Fix the use of some C domain roles (#107092)

2023-07-23 12:27:05 +02:00

module.rst

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

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

monitoring.rst

Python 3.14.0a7

2025-04-08 14:20:51 +03:00

none.rst

gh-110481, doc: Add "immortal" term to the glossary (#112180)

2023-11-17 15:09:19 +01:00

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-133140: Add PyUnstable_Object_IsUniquelyReferenced for free-threading (#133144)

2025-05-05 21:01:20 +02: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

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

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

refcounting.rst

gh-133140: Add PyUnstable_Object_IsUniquelyReferenced for free-threading (#133144)

2025-05-05 21:01:20 +02: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-101100: Fix Sphinx reference warnings (GH-112416)

2023-11-25 15:40:19 -08:00

slice.rst

gh-130214: Document PyEllipsis_Type (GH-130215)

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

stable.rst

gh-127253: Note that Stable ABI is about ABI stability (GH-127254)

2024-12-03 13:30:27 +01:00

structures.rst

gh-130711: Document PyBaseObject_Type (GH-130712)

2025-03-03 15:08:05 +01:00

sys.rst

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

2025-03-20 13:06:59 +01: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

gh-124182: Explain naming rules for struct sequence types (#124335)

2024-10-07 19:52:34 +02:00

type.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

typehints.rst

gh-107298: Fix Sphinx warnings in the C API doc (#107302)

2023-07-27 01:41:15 +02:00

typeobj.rst

[3.14] gh-132246: Add special buffer methods to C API Type Object docs (gh-132247) (gh-134426)

2025-05-21 16:33:35 +02:00

unicode.rst

[3.14] gh-46236: Document PyUnicode_BuildEncodingMap (GH-133270) (#133769)

2025-05-09 15:24:59 +00:00

utilities.rst

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

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

veryhigh.rst

gh-118915: C API: Document compiler flag macros (GH-129028)

2025-01-20 17:45:08 +01:00

weakref.rst

gh-128008: Add PyWeakref_IsDead() (GH-128009)

2024-12-19 16:17:15 +01:00