Repository navigation
Doc: fix PyBytesWriter sample code - #160756
Merged
Merged
Conversation
Documentation build overview
|
aisk
approved these changes
Oct 27, 2026
There was a problem hiding this comment.
🟢 Approval recommended
The three focused documentation corrections match the API usage, with no unresolved issues.
No open issues 🎉
What changed in this PR
This PR corrects C sample code in the bytes API documentation so the examples use the intended output size and return types.
Changes:
- Advance the writer pointer by all three copied bytes before finishing.
- Change both
create_string()examples to returnPyObject*instead ofvoid.
| File | Description |
|---|---|
Doc/c-api/bytes.rst |
Corrects pointer advancement and function return types in bytes API examples. |
Review effort: Balanced
vstinner
approved these changes
Oct 27, 2026
vstinner
left a comment
Member
There was a problem hiding this comment.
LGTM. Ooopsie, I missed these mistakes when I wrote the examples. Well spotted, thanks for fixing them.
|
Thanks @methane for the PR 🌮🎉.. I'm working now to backport this PR to: 3.15. |
|
GH-160796 is a backport of this pull request to the 3.15 branch. |
methane
added a commit
that referenced
this pull request
Oct 28, 2026
(cherry picked from commit d824240) Co-authored-by: Inada Naoki <songofacandy@gmail.com>
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
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.
No description provided.