Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

gh-90717: Update the documentation for the altchars paremeter in base64 library #94187

Merged
merged 2 commits into from Nov 29, 2022

Conversation

dignissimus
Copy link
Contributor

@dignissimus dignissimus commented Jun 23, 2022

Updates the documentation for the base64 library to reflect changes in the behaviour of base64.b64encode and base64.b64decode with respect to the altchars parameter, the values it can take on and the exceptions the function raises when the altchars parameter is passed an invalid value.

Resolves #90717

@bedevere-bot bedevere-bot added awaiting review docs Documentation in the Doc dir labels Jun 23, 2022
Doc/library/base64.rst Outdated Show resolved Hide resolved
Doc/library/base64.rst Outdated Show resolved Hide resolved
Copy link
Member

@iritkatriel iritkatriel left a comment

See @zooba 's comments.

@bedevere-bot
Copy link

bedevere-bot commented Nov 27, 2022

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

@dignissimus
Copy link
Contributor Author

dignissimus commented Nov 29, 2022

Changes made in fbb9798

I have made the requested changes; please review again

@bedevere-bot
Copy link

bedevere-bot commented Nov 29, 2022

Thanks for making the requested changes!

@iritkatriel: please review the changes made to this pull request.

@bedevere-bot bedevere-bot requested a review from iritkatriel Nov 29, 2022
@zooba zooba merged commit 05dfc53 into python:main Nov 29, 2022
14 checks passed
@zooba
Copy link
Member

zooba commented Nov 29, 2022

Great, thanks!

@miss-islington
Copy link
Contributor

miss-islington commented Nov 29, 2022

Thanks @dignissimus for the PR, and @zooba for merging it 🌮🎉.. I'm working now to backport this PR to: 3.10.
🐍🍒🤖

@miss-islington
Copy link
Contributor

miss-islington commented Nov 29, 2022

Thanks @dignissimus for the PR, and @zooba for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11.
🐍🍒🤖

@miss-islington
Copy link
Contributor

miss-islington commented Nov 29, 2022

Sorry, @dignissimus and @zooba, I could not cleanly backport this to 3.10 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker 05dfc539c2de34021e44f621f2b7b993682ee200 3.10

@bedevere-bot
Copy link

bedevere-bot commented Nov 29, 2022

GH-99878 is a backport of this pull request to the 3.11 branch.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Nov 29, 2022
…n base64 library (pythonGH-94187)

(cherry picked from commit 05dfc53)

Co-authored-by: Sam Ezeh <sam.z.ezeh@gmail.com>
@bedevere-bot
Copy link

bedevere-bot commented Nov 29, 2022

GH-99879 is a backport of this pull request to the 3.10 branch.

miss-islington added a commit that referenced this pull request Nov 29, 2022
…64 library (GH-94187)

(cherry picked from commit 05dfc53)

Co-authored-by: Sam Ezeh <sam.z.ezeh@gmail.com>
zooba added a commit that referenced this pull request Nov 29, 2022
…64 library (GH-94187)

Co-authored-by: Sam Ezeh <sam.z.ezeh@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

base64 documentation is out-dated; altchars has to have the exact length of 2.
7 participants