gh-134837: Correct and improve base85 documentation for base64 module#145843
Open
dhdaines wants to merge 7 commits intopython:mainfrom
Open
gh-134837: Correct and improve base85 documentation for base64 module#145843dhdaines wants to merge 7 commits intopython:mainfrom
dhdaines wants to merge 7 commits intopython:mainfrom
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
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.
As noted in the issue there are a few clarifications needed in the "Base85 Encodings" section of the
base64module documentation. Namely:adobe=Truewas not fully specified, particularly that it raisesValueErroron unterminated inputpad=Truewas not correctly described - the input is always padded, the question is whether this padding is retained in the output encoding.Also note that
pad=Trueis required by the ZeroMQ standard, but perhaps ZeroMQ is tolerant of Z85 encoded data that isn't a multiple of 5 bytes.base64.a85(en,de)codedocumentation for Adobe mode #134837📚 Documentation preview 📚: https://cpython-previews--145843.org.readthedocs.build/