8000 gh-132246: Add special buffer methods to C API Type Object docs (gh-1… · python/cpython@b529b60 · GitHub
[go: up one dir, main page]
Skip to content

Commit b529b60

Browse files
cmaloneycmaloney
authored
gh-132246: Add special buffer methods to C API Type Object docs (gh-132247)
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.
1 parent d862b6d commit b529b60

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

‎Doc/c-api/typeobj.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ Quick Reference
7979
| :c:member:`~PyTypeObject.tp_setattro` | :c:type:`setattrofunc` | __setattr__, | X | X | | G |
8080
| | | __delattr__ | | | | |
8181
+------------------------------------------------+-----------------------------------+-------------------+---+---+---+---+
82-
| :c:member:`~PyTypeObject.tp_as_buffer` | :c:type:`PyBufferProcs` * | | | | | % |
82+
| :c:member:`~PyTypeObject.tp_as_buffer` | :c:type:`PyBufferProcs` * | :ref:`sub-slots` | | | | % |
8383
+------------------------------------------------+-----------------------------------+-------------------+---+---+---+---+
8484
| :c:member:`~PyTypeObject.tp_flags` | unsigned long | | X | X | | ? |
8585
+------------------------------------------------+-----------------------------------+-------------------+---+---+---+---+
@@ -325,9 +325,10 @@ sub-slots
325325
+---------------------------------------------------------+-----------------------------------+---------------+
326326
| |
327327
+---------------------------------------------------------+-----------------------------------+---------------+
328-
| :c:member:`~PyBufferProcs.bf_getbuffer` | :c:func:`getbufferproc` | |
328+
| :c:member:`~PyBufferProcs.bf_getbuffer` | :c:func:`getbufferproc` | __buffer__ |
329329
+---------------------------------------------------------+-----------------------------------+---------------+
330-
| :c:member:`~PyBufferProcs.bf_releasebuffer` | :c:func:`releasebufferproc` | |
330+
| :c:member:`~PyBufferProcs.bf_releasebuffer` | :c:func:`releasebufferproc` | __release_\ |
331+
| | | buffer\__ |
331332
+---------------------------------------------------------+-----------------------------------+---------------+
332333

333334
.. _slot-typedefs-table:

0 commit comments

Comments
 (0)
0