Skip to content

gh-123609: Clarify usage of standalone PyBUF_FORMAT #123778

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
Merged
merged 6 commits into from
Sep 10, 2024
Merged

gh-123609: Clarify usage of standalone PyBUF_FORMAT #123778

merged 6 commits into from
Sep 10, 2024

Conversation

@ZeroIntensity
Copy link
Member

@ZeroIntensity ZeroIntensity commented Sep 6, 2024 •
edited
Loading

(@encukou, this needs skip news. Edit: nevermind, apparently the bot does that! 😄)

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

@bedevere-app bedevere-app bot added awaiting review docs Documentation in the Doc dir skip news labels Sep 6, 2024
@bedevere-app bedevere-app bot mentioned this pull request Sep 6, 2024
Closed
encukou
encukou reviewed Sep 6, 2024
View reviewed changes
@ZeroIntensity @encukou
Update Doc/c-api/buffer.rst
82f7d21 
Co-authored-by: Petr Viktorin <encukou@gmail.com>
@ZeroIntensity
Copy link
Member Author

ZeroIntensity commented Sep 8, 2024 •
edited
Loading

@philthompson10 I've tried to make this more user-facing, could you review? (It's better to keep the message short so people don't skip over it.)

@philthompson10
Copy link

To be honest I'd rewrite the whole Buffer request types section and split it into a PyBUF_SIMPLE (with optional PyBUF_WRITABLE) sub-section and a non-PyBUF_SIMPLE sub-section.

If not then I'd at least change the last sentence of the previous paragraph to...

PyBUF_SIMPLE | PyBUF_WRITABLE can be used to request a simple writable buffer.

I know that PyBUF_SIMPLE isn't necessary with the current implementation but the above makes the intent much more clear.

@ZeroIntensity
Copy link
Member Author

Rewriting the section is probably out of the scope of this PR, but I did just add that sentence.

encukou
encukou reviewed Sep 9, 2024
View reviewed changes
@ZeroIntensity @encukou
Update buffer.rst
beee985 
Co-authored-by: Petr Viktorin <encukou@gmail.com>
@encukou encukou merged commit 962304a into python:main Sep 10, 2024
21 checks passed
@encukou encukou added needs backport to 3.12 only security fixes needs backport to 3.13 bugs and security fixes labels Sep 10, 2024
@miss-islington-app
Copy link

Thanks @ZeroIntensity for the PR, and @encukou for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13.
🐍🍒⛏🤖

@miss-islington-app
Copy link

Thanks @ZeroIntensity for the PR, and @encukou for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Sep 10, 2024
@ZeroIntensity @miss-islington
pythongh-123609: Clarify usage of standalone PyBUF_FORMAT (pythonGH…
2a571da 
…-123778)

(cherry picked from commit 962304a)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Sep 10, 2024
@ZeroIntensity @miss-islington
pythongh-123609: Clarify usage of standalone PyBUF_FORMAT (pythonGH…
ac32245 
…-123778)

(cherry picked from commit 962304a)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
@bedevere-app
Copy link

bedevere-app bot commented Sep 10, 2024

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

@bedevere-app bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Sep 10, 2024
@bedevere-app
Copy link

bedevere-app bot commented Sep 10, 2024

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

@bedevere-app bedevere-app bot removed the needs backport to 3.12 only security fixes label Sep 10, 2024
@ZeroIntensity ZeroIntensity deleted the pybufformat-pybufsimple branch September 10, 2024 13:43
Yhg1s pushed a commit that referenced this pull request Sep 24, 2024
@miss-islington @ZeroIntensity
[3.13] gh-123609: Clarify usage of standalone PyBUF_FORMAT (GH-123778…
ed69247 
…) (#123903)

gh-123609: Clarify usage of standalone `PyBUF_FORMAT` (GH-123778)
(cherry picked from commit 962304a)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
willingc pushed a commit that referenced this pull request Nov 1, 2024
@miss-islington @ZeroIntensity
[3.12] gh-123609: Clarify usage of standalone PyBUF_FORMAT (GH-123778…
ce5bb3c 
…) (GH-123904)

gh-123609: Clarify usage of standalone `PyBUF_FORMAT` (GH-123778)
(cherry picked from commit 962304a)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@encukou encukou encukou approved these changes

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.

3 participants

@ZeroIntensity @philthompson10 @encukou