← 返回首页
gh-119467: Fix Py_buffer.format type and correct documentation typo by adiaholic · Pull Request #119475 · python/cpython · GitHub
Skip to content

Navigation Menu

Toggle navigation
Sign in
Appearance settings
Search or jump to...

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Include my email address so I can be contacted
Cancel Submit feedback

Saved searches

Use saved searches to filter your results more quickly

Cancel Create saved search
Appearance settings
Resetting focus

gh-119467: Fix Py_buffer.format type and correct documentation typo#119475

Merged
kumaraditya303 merged 1 commit into
python:mainfrom
adiaholic:fix-issue-119467
May 27, 2024
Merged

gh-119467: Fix Py_buffer.format type and correct documentation typo#119475
kumaraditya303 merged 1 commit into
python:mainfrom
adiaholic:fix-issue-119467

Conversation

adiaholic commented May 23, 2024 •
edited by github-actions Bot
Loading

Copy link
Copy Markdown
Contributor

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 to char * 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/

ghost commented May 23, 2024 •
edited by ghost
Loading

Copy link
Copy Markdown

All commit authors signed the Contributor License Agreement.

bedevere-app Bot added docs Documentation in the Doc dir skip news awaiting review labels May 23, 2024
bedevere-app Bot mentioned this pull request May 23, 2024
Closed
Fix Py_buffer.format type and correct documentation typo …
1facf3a
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
blaisep approved these changes May 24, 2024
View reviewed changes

blaisep left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality Hide 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.

Eclips4 approved these changes May 24, 2024
View reviewed changes

Eclips4 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality Hide comment

Thanks!

Eclips4 added needs backport to 3.12 only security fixes needs backport to 3.13 bugs and security fixes labels May 24, 2024
kumaraditya303 merged commit 3b26cd8 into python:main May 27, 2024

miss-islington-app Bot commented May 27, 2024

Copy link
Copy Markdown

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
pythongh-119467: Fix Py_buffer.format type and correct documentation … …
f8fab8b
…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
pythongh-119467: Fix Py_buffer.format type and correct documentation … …
713d85a
…typo (pythonGH-119475) (cherry picked from commit 3b26cd8) Co-authored-by: Aditya Borikar <adityaborikar2@gmail.com>

bedevere-app Bot commented May 27, 2024

Copy link
Copy Markdown

GH-119602 is a backport of this pull request to the 3.13 branch.

bedevere-app Bot removed the needs backport to 3.13 bugs and security fixes label May 27, 2024

bedevere-app Bot commented May 27, 2024

Copy link
Copy Markdown

GH-119603 is a backport of this pull request to the 3.12 branch.

bedevere-app Bot removed the needs backport to 3.12 only security fixes label May 27, 2024
kumaraditya303 pushed a commit that referenced this pull request May 27, 2024
[3.12] gh-119467: Fix Py_buffer.format type and correct documentation… …
8d7e54a
… typo (GH-119475) (#119603) gh-119467: Fix Py_buffer.format type and correct documentation typo (GH-119475) (cherry picked from commit 3b26cd8) Co-authored-by: Aditya Borikar <adityaborikar2@gmail.com>
kumaraditya303 pushed a commit that referenced this pull request May 27, 2024
[3.13] gh-119467: Fix Py_buffer.format type and correct documentation… …
f1302c1
… typo (GH-119475) (#119602) gh-119467: Fix Py_buffer.format type and correct documentation typo (GH-119475) (cherry picked from commit 3b26cd8) Co-authored-by: Aditya Borikar <adityaborikar2@gmail.com>
JelleZijlstra mentioned this pull request May 28, 2024
Closed
estyxx pushed a commit to estyxx/cpython that referenced this pull request Jul 17, 2024
pythongh-119467: Fix Py_buffer.format type and correct documentation … …
1fe7701
…typo (python#119475)
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
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

kumaraditya303 kumaraditya303 approved these changes
Eclips4 Eclips4 approved these changes
+1 more reviewer
blaisep blaisep approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

Footer

© 2026 GitHub, Inc.