gh-90120: Specify UTF-8 encoding in PyModule_AddString{Constant,Macro} docs
#131597
Conversation
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
|
All commit authors signed the Contributor License Agreement. |
ZeroIntensity
previously approved these changes
Mar 27, 2025
Comment on lines
+657
to
+658
| *STRINGLIB_TYPE_NAME* to *module*. The string *value* must be | ||
| ``NULL``-terminated and UTF-8 encoded. |
There was a problem hiding this comment.
value is not a variable we know about here. It makes sense for PyModule_AddStringConstant because there's a value parameter.
Instead, let's do something like this:
Suggested change
| *STRINGLIB_TYPE_NAME* to *module*. The string *value* must be | |
| ``NULL``-terminated and UTF-8 encoded. | |
| *STRINGLIB_TYPE_NAME* to *module*. The contents of the macro must be | |
| ``NULL``-terminated and UTF-8 encoded. |
I think it would also make more sense to move that sentence to before "For example".
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.
This is my first commit(s) and PR to
cpython, thought I'd pick up some docs updates first 📝😄Issue: #90120
📚 Documentation preview 📚: https://cpython-previews--131597.org.readthedocs.build/