gh-131885: Document / for codecs functions#131992
Merged
Uh oh!
There was an error while loading. Please reload this page.
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
CodecInfoclass signature contains an undocumented (non-public)_is_text_encodingargument: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 forcodecsfunctions 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/
*and/as needed #131885