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

PEP 3104: Add footnote to give example #2027

Merged
merged 1 commit into from
Jul 6, 2021
Merged

Conversation

SA-WS
Copy link
Contributor

@SA-WS SA-WS commented Jul 6, 2021

While reading PEP 3104 to understand the nonlocal keyword, I found the explanation for why an alternative was not chosen to be vague. Further digging revealed an example for why there was a concern that .x and x could be used interchangeably. I linked this example as a footnote to save future readers time from digging to find an example. I hope this will increase comprehension of the PEP for future learners.

While reading PEP 3104 to understand the ``nonlocal`` keyword, I found the explanation for why an alternative was not chosen to be vague. Further digging revealed an example for why there was a concern that ``.x`` and ``x`` could be used interchangeably. I linked this example as a footnote to save future readers time from digging to find an example. I hope this will increase comprehension of the PEP for future learners.
@SA-WS SA-WS requested a review from a team as a code owner July 6, 2021 00:55
@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 this contribution by verifying everyone involved has signed the PSF contributor agreement (CLA).

Recognized GitHub username

We couldn't find a bugs.python.org (b.p.o) account corresponding to the following GitHub usernames:

@SA-WS

This might be simply due to a missing "GitHub Name" entry in one's b.p.o account settings. This is necessary for legal reasons before we can look at this contribution. Please follow the steps outlined in the CPython devguide to rectify this issue.

You can check yourself to see if the CLA has been received.

Thanks again for the contribution, we look forward to reviewing it!

Copy link
Member

@gvanrossum gvanrossum left a comment

Choose a reason for hiding this comment

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

Thanks! This is a worthy improvement. Even though we normally don't change PEPs after the fact (other than to fix typos or stale links), I am accepting this.

I hope you will still apply for the CLA.

@gvanrossum gvanrossum merged commit 6e85aea into python:master Jul 6, 2021
@SA-WS
Copy link
Contributor Author

SA-WS commented Jul 6, 2021

Thanks! This is a worthy improvement. Even though we normally don't change PEPs after the fact (other than to fix typos or stale links), I am accepting this.

I hope you will still apply for the CLA.

Thank you! Happy to contribute, CLA applied for!

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.

3 participants