gh-131885: Document / for codecs functions - #131992
Merged
vstinner merged 1 commit intoApr 14, 2025
Merged
Conversation
Copy link
Copy Markdown
Contributor
Sorry, something went wrong.
5 tasks
vstinner
approved these changes
Apr 2, 2025
vstinner
left a comment
Copy link
Copy Markdown
Member
There was a problem hiding this comment.
LGTM
Sorry, something went wrong.
Copy link
Copy Markdown
|
All commit authors signed the Contributor License Agreement. |
Sorry, something went wrong.
Copy link
Copy Markdown
Member
|
Merged, thank you. |
Sorry, something went wrong.
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.
1. I found that CodecInfo class signature contains an undocumented (non-public) _is_text_encoding argument:
cpython/Lib/codecs.py
Lines 94 to 96 in c2ac662
Signature, inspect.signature(codecs.CodecInfo):
I don't think this should be documented, but I thought I'd point it out just in case.
2. I'm not a fan of using / and I also want to point out that it doesn't seem natural for codecs functions to use positional-only arguments, since they are only used in the functions that I updated. I would suggest getting rid of / in the code instead of documenting it.
📚 Documentation preview 📚: https://cpython-previews--131992.org.readthedocs.build/