GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — gh-119467: Fix Py_buffer.format type and correct documentation typo by adiaholic · Pull Request #119475 · python/cpython

Conversation

@adiaholic

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

Uh oh!

There was an error while loading. Please reload this page.

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.

  • Issue: Py_buffer.format declaration inconsistent with the docs #119467

📚 Documentation preview 📚: https://cpython-previews--119475.org.readthedocs.build/

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@ghost

ghost commented May 23, 2024 •
edited by ghost
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown

All commit authors signed the Contributor License Agreement.
CLA signed
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@bedevere-app bedevere-app Bot added docs Documentation in the Doc dir skip news awaiting review labels May 23, 2024
@bedevere-app bedevere-app Bot mentioned this pull request May 23, 2024
Py_buffer.format declaration inconsistent with the docs #119467
Closed
@adiaholic
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
@adiaholic
adiaholic force-pushed the fix-issue-119467 branch from 29f5520 to 1facf3a Compare May 23, 2024 22:06
blaisep
blaisep approved these changes May 24, 2024
View reviewed changes

@blaisep blaisep left a comment

Copy link
Copy Markdown
Contributor

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

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.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
adiaholic reacted with heart emoji
All reactions
  • ❤️ 1 reaction
@bedevere-app bedevere-app Bot added awaiting core review and removed awaiting review labels May 24, 2024
Eclips4
Eclips4 approved these changes May 24, 2024
View reviewed changes

@Eclips4 Eclips4 left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

Thanks!

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
adiaholic reacted with heart emoji
All reactions
  • ❤️ 1 reaction
@Eclips4 Eclips4 added needs backport to 3.12 only security fixes needs backport to 3.13 only security fixes labels May 24, 2024
kumaraditya303
kumaraditya303 approved these changes May 27, 2024
View reviewed changes
@bedevere-app bedevere-app Bot added awaiting merge and removed awaiting core review labels May 27, 2024
@kumaraditya303
kumaraditya303 merged commit 3b26cd8 into python:main May 27, 2024
@miss-islington-app

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.
🐍🍒⛏🤖
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@bedevere-app bedevere-app Bot removed the awaiting merge label May 27, 2024
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request May 27, 2024
@adiaholic @miss-islington
pythongh-119467: Fix Py_buffer.format type and correct documentation …
f8fab8b 
…typo (pythonGH-119475)

(cherry picked from commit 3b26cd8)

Co-authored-by: Aditya Borikar <[email protected]>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request May 27, 2024
@adiaholic @miss-islington
pythongh-119467: Fix Py_buffer.format type and correct documentation …
713d85a 
…typo (pythonGH-119475)

(cherry picked from commit 3b26cd8)

Co-authored-by: Aditya Borikar <[email protected]>
@bedevere-app

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.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@bedevere-app bedevere-app Bot removed the needs backport to 3.13 only security fixes label May 27, 2024
@bedevere-app

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.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@bedevere-app 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
@miss-islington @adiaholic
[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 <[email protected]>
kumaraditya303 pushed a commit that referenced this pull request May 27, 2024
@miss-islington @adiaholic
[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 <[email protected]>
@JelleZijlstra JelleZijlstra mentioned this pull request May 28, 2024
backport a9a74da 3.13 #119642
Closed
estyxx pushed a commit to estyxx/cpython that referenced this pull request Jul 17, 2024
@adiaholic @estyxx
pythongh-119467: Fix Py_buffer.format type and correct documentation …
1fe7701 
…typo (python#119475)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

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

Uh oh!

There was an error while loading. Please reload this page.

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.

Uh oh!

There was an error while loading. Please reload this page.

4 participants

@adiaholic @blaisep @kumaraditya303 @Eclips4
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.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.