Repository navigation
gh-148431: Clarify format and item size in buffer requests - #159832
Open
limadog9 wants to merge 1 commit into
Open
limadog9 wants to merge 1 commit into
limadog9 wants to merge 1 commit into
Conversation
Copy link
Copy Markdown
Contributor
Sorry, something went wrong.
Copy link
Copy Markdown
Documentation build overview1 file changed ± c-api/buffer.html |
Sorry, something went wrong.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Reviewers
1 participant
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.
Fixes #148431.
Clarify that a NULL Py_buffer.format does not imply that the original elements have size one when shape information is present. Explain that PyBUF_FORMAT is optional for structured requests and must be combined with PyBUF_ND or a flag that includes it, rather than used alone or only with PyBUF_WRITABLE.
Validation: the full Sphinx HTML build passed with warnings treated as errors; sphinx-lint and git diff --check passed. Verified the described behavior with a non-byte memoryview and _testbuffer.ndarray, covering PyBUF_ND, PyBUF_STRIDED_RO, PyBUF_SIMPLE, and format requests with and without shape information.