gh-132246: Add special buffer methods to C API Type Object docs #132247
+10
−3
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
bedevere-app
bot
added
awaiting review
docs
cmaloney
commented
Apr 8, 2025
| @@ -325,9 +325,16 @@ sub-slots | |||
| +---------------------------------------------------------+-----------------------------------+---------------+ | |||
| | | | |||
| +---------------------------------------------------------+-----------------------------------+---------------+ | |||
| | :c:member:`~PyBufferProcs.bf_getbuffer` | :c:func:`getbufferproc` | | | |||
| | :c:member:`~PyBufferProcs.bf_getbuffer` | :c:func:`getbufferproc` | :meth:`\ | | |||
There was a problem hiding this comment.
The :meth: references make it link to the right document; can also match the other cases and not use. The __release_buffer__ is one character wider than the table column even without the :meth: pieces...
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Two special methods,
__buffer__and__release_buffer__were added to Python 3.12 by PEP-688. The C API Type Object documentation for slots includestp_as_buffer, and sub-slotsbf_getbuffer,bf_releasebufferbut does not refer to the Python Data Model version of those. Add the missing references.📚 Documentation preview 📚: https://cpython-previews--132247.org.readthedocs.build/