Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Py_buffer.format declaration inconsistent with the docs #119467

Closed
philthompson10 opened this issue May 23, 2024 · 3 comments
Closed

Py_buffer.format declaration inconsistent with the docs #119467

philthompson10 opened this issue May 23, 2024 · 3 comments
Labels
3.12 bugs and security fixes 3.13 bugs and security fixes 3.14 new features, bugs and security fixes docs Documentation in the Doc dir easy topic-C-API type-bug An unexpected behavior, bug, or error

Comments

@philthompson10
Copy link

philthompson10 commented May 23, 2024 •
edited by bedevere-app bot
Loading

Bug report

Bug description:

The declaration of the format field of the Py_buffer structure is char * but the documentation states it is const char *.

IMHO the declaration should be changed to match the docs.

CPython versions tested on:

3.8, 3.9, 3.10, 3.11, 3.12, 3.13

Operating systems tested on:

Linux, macOS, Windows

Linked PRs
@philthompson10 philthompson10 added the type-bug An unexpected behavior, bug, or error label May 23, 2024
@Eclips4 Eclips4 added docs Documentation in the Doc dir topic-C-API labels May 23, 2024
@Eclips4
Copy link
Member

Eclips4 commented May 23, 2024

Hello!
Would you like to send a PR with fix? :)

@Eclips4 Eclips4 added 3.12 bugs and security fixes 3.13 bugs and security fixes 3.14 new features, bugs and security fixes easy labels May 23, 2024
@philthompson10
Copy link
Author

I'd like to - may take a while...

adiaholic added a commit to adiaholic/cpython that referenced this issue May 23, 2024
@adiaholic
Fix Py_buffer.format type and correct documentation typo
ab0f20f 
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 mentioned this issue May 23, 2024
Merged
@adiaholic
Copy link
Contributor

I have pushed a fix for this inconsistency. It would be great if @Eclips4 could review the changes and confirm if this resolves the issue.

Feedback is highly appreciated!

adiaholic added a commit to adiaholic/cpython that referenced this issue May 23, 2024
@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
kumaraditya303 pushed a commit that referenced this issue May 27, 2024
@adiaholic
gh-119467: Fix Py_buffer.format type and correct documentation typo (#…
3b26cd8 
…119475)
miss-islington pushed a commit to miss-islington/cpython that referenced this issue 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 <adityaborikar2@gmail.com>
@bedevere-app bedevere-app bot mentioned this issue May 27, 2024
Merged
miss-islington pushed a commit to miss-islington/cpython that referenced this issue 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 <adityaborikar2@gmail.com>
@bedevere-app bedevere-app bot mentioned this issue May 27, 2024
Merged
kumaraditya303 pushed a commit that referenced this issue 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 <adityaborikar2@gmail.com>
kumaraditya303 pushed a commit that referenced this issue 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 <adityaborikar2@gmail.com>
@JelleZijlstra JelleZijlstra mentioned this issue May 28, 2024
Closed
estyxx pushed a commit to estyxx/cpython that referenced this issue 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
Assignees
No one assigned
Labels
3.12 bugs and security fixes 3.13 bugs and security fixes 3.14 new features, bugs and security fixes docs Documentation in the Doc dir easy topic-C-API type-bug An unexpected behavior, bug, or error
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@philthompson10 @adiaholic @kumaraditya303 @Eclips4