gh-119467: Fix Py_buffer.format type and correct documentation typo #119475
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
|
All commit authors signed the Contributor License Agreement. |
This commit addresses the inconsistency between the Py_buffer.format declaration and its documentation as reported in issue python#119467. The documentation previously stated `const char *` for the format field, which has been corrected to `char *` to match the actual code declaration. Additionally, a spelling mistake in the documentation has been corrected to enhance clarity and accuracy. References: - Issue: python#119467
29f5520 to
1facf3a
Compare
blaisep
approved these changes
May 24, 2024
There was a problem hiding this comment.
Hi @adiaholic , thank you for your first contribution.
These details help raise confidence in the quality of the docs.
I will ask if @encukou can merge this because he is more familiar with the C API and he has the merge authority.
kumaraditya303
approved these changes
May 27, 2024
|
Thanks @adiaholic for the PR, and @kumaraditya303 for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13. |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
May 27, 2024
…typo (pythonGH-119475) (cherry picked from commit 3b26cd8) Co-authored-by: Aditya Borikar <adityaborikar2@gmail.com>
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
May 27, 2024
…typo (pythonGH-119475) (cherry picked from commit 3b26cd8) Co-authored-by: Aditya Borikar <adityaborikar2@gmail.com>
|
GH-119602 is a backport of this pull request to the 3.13 branch. |
|
GH-119603 is a backport of this pull request to the 3.12 branch. |
kumaraditya303
pushed a commit
that referenced
this pull request
May 27, 2024
kumaraditya303
pushed a commit
that referenced
this pull request
May 27, 2024
estyxx
pushed a commit
to estyxx/cpython
that referenced
this pull request
Jul 17, 2024
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.
This commit addresses the inconsistency between the Py_buffer.format declaration and its documentation as reported in issue #119467.
The documentation previously stated
const char *for the format field, which has been corrected tochar *to match the actual code declaration. Additionally, a spelling mistake in the documentation has been corrected to enhance clarity and accuracy.📚 Documentation preview 📚: https://cpython-previews--119475.org.readthedocs.build/