8000 bpo-36700: Updated obsolete references for RFC 3548 to RFC 4648 by paulehoffman · Pull Request #2336 · python/cpython · GitHub
[go: up one dir, main page]

Skip to content

bpo-36700: Updated obsolete references for RFC 3548 to RFC 4648 #2336

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

Closed
wants to merge 3 commits into from
Closed

bpo-36700: Updated obsolete references for RFC 3548 to RFC 4648 #2336

wants to merge 3 commits into from

Conversation

paulehoffman
Copy link
Contributor
@paulehoffman paulehoffman commented Jun 23, 2017

Updating just the documentation for base64 library. The RFC that was reference was obsolete. The description of both the old and new RFCs was incorrect in saying that they allowed optional changes; the proposed new wording makes this clear without deprecating the option.

https://bugs.python.org/issue36700

@the-knights-who-say-ni
Copy link

Hello, and thanks for your contribution!

I'm a bot set up to make sure that the project can legally accept your contribution by verifying you have signed the PSF contributor agreement (CLA).

Unfortunately our records indicate you have not signed the CLA. For legal reasons we need you to sign this before we can look at your contribution. Please follow the steps outlined in the CPython devguide to rectify this issue.

Thanks again to your contribution and we look forward to looking at it!

@mention-bot
Copy link

@paulehoffman, thanks for your PR! By analyzing the history of the files in this pull request, we identified @birkenfeld, @serhiy-storchaka and @Carreau to be potential reviewers.

@paulehoffman
Copy link
Contributor Author

I signed the CLA earlier today, so I'm not sure why the bot didn't find it.

@paulehoffman paulehoffman changed the title Updated obsolete references for RFC 3548 to RFC 4648 Updated obsolete references for RFC 3548 to RFC 4648 (trivial) Jun 23, 2017
@lf-
Copy link
Contributor
lf- commented Jun 24, 2017

Your indent on line 133 appears to have offended the CI bot for some reason. (just looked, it's an extra space at the start of the line. Probably want to fix that.)

Lib/base64.py Outdated

# Modified 04-Oct-1995 by Jack Jansen to use binascii module
# Modified 30-Dec-2003 by Barry Warsaw to add full RFC 3548 support
# Modified 30-Dec-2003 by Barry Warsaw to add full RFC 4648 support
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

...that appears to be an incorrect change, rewriting history...

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good call. I have reverted that in d585264.

Copy link
Member
@serhiy-storchaka serhiy-storchaka left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please open an issue on the bug tracker for discussion.

We should check that the module supports the new RFC, not just update the number.

@bedevere-bot
Copy link

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.

@csabella
Copy link
Contributor

@paulehoffman Thank you for the suggested change and for the PR! If you've opened a bug tracker ticket per @serhiy-storchaka's review, please update the PR title with the bpo number and remove the trivial comment. If you haven't yet opened a ticket, please do so in order for review of this PR to proceed. Thanks!

@paulehoffman paulehoffman changed the title Updated obsolete references for RFC 3548 to RFC 4648 (trivial) Updated obsolete references for RFC 3548 to RFC 4648; bug tracker issue 36700 Apr 22, 2019
@paulehoffman
Copy link
Contributor Author

I have made the requested changes; please review again

@bedevere-bot
Copy link

Thanks for making the requested changes!

@serhiy-storchaka: please review the changes made to this pull request.

@serhiy-storchaka serhiy-storchaka changed the title Updated obsolete references for RFC 3548 to RFC 4648; bug tracker issue 36700 bpo-36700: Updated obsolete references for RFC 3548 to RFC 4648 Apr 23, 2019
(oh), and for optional mapping of the digit 1 (one) to either the letter I (eye)
or letter L (el). The optional argument *map01* when not ``None``, specifies
which letter the digit 1 should be mapped to (when *map01* is not ``None``, the
digit 0 is always mapped to the letter O). For security purposes the default is
``None``, so that 0 and 1 are not allowed in the input.
``None``, so that 0 and 1 are not allowed in the input. Note that :rfc:`4648`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this true? Looks to me like the relevant language is present on page 5 of RFC 4648. The wording is a little different from RFC 3548 but the gist seems to be the same.

Copy link
Member

Choose a reas 8000 on for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This change is also not mentioned in the Changes since RFC 3548 section. I think we can leave the original wording on these pages and just update the number.

@csabella
Copy link
Contributor

@paulehoffman, please address the code review and resolve the merge conflicts. Thanks!

@pganssle
Copy link
Member

This PR is quite old, but the blocker is now fixed. @paulehoffman do you mind rebasing it against master and addressing this comment?

@vstinner vstinner closed this May 3, 2021
@vstinner vstinner deleted the branch python:master May 3, 2021 21:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0