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-74929: locals() documentation update for PEP 667 #118265

Merged
merged 3 commits into from
May 6, 2024

Conversation

ncoghlan
Copy link
Contributor

@ncoghlan ncoghlan commented Apr 25, 2024

Proposed documentation wording taken from the
withdrawn PEP 558 (which had switched to the
Python level semantics proposed in PEP 667 prior
to its withdrawal).


📚 Documentation preview 📚: https://cpython-previews--118265.org.readthedocs.build/

Proposed documentation wording taken from the
withdrawn PEP 558 (which had switched to the
Python level semantics proposed in PEP 667 prior
to its withdrawal).
@ncoghlan
Copy link
Contributor Author

DO-NOT-MERGE label added, as this should only be merged after the PEP 667 implementation in #115153 has been completed and merged.

@ncoghlan ncoghlan changed the title locals() documentation update for PEP 667 gh-74929: locals() documentation update for PEP 667 Apr 26, 2024
@nineteendo
Copy link
Contributor

Wouldn't it better to convert the pull request back to a draft? GitHub automatically prevents you from merging those.

@ncoghlan ncoghlan self-assigned this Apr 28, 2024
@ncoghlan ncoghlan marked this pull request as draft April 28, 2024 10:04
@ncoghlan
Copy link
Contributor Author

Wouldn't it better to convert the pull request back to a draft? GitHub automatically prevents you from merging those.

Good point, done (enough years of experience where draft PRs weren't available that I still forget to use them when appropriate)

implicitly refreshed by other operations, such as calling ``locals()``
again. Obtaining the legacy CPython behaviour now requires explicit
calls to update the initially returned dictionary with the results
of subsequent calls to ``locals()``.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I plan to eventually replace the latter two sentences here with something like "For details, refer to the 'Python 3.13 porting guide'" (with a link to the relevant part of the 3.13 What's New document). That will be in a later PR that adds an initial version of the What's New update for PEP 667, though.

@ncoghlan ncoghlan marked this pull request as ready for review May 6, 2024 10:04
@ncoghlan ncoghlan merged commit 757fd3e into python:main May 6, 2024
26 checks passed
SonicField pushed a commit to SonicField/cpython that referenced this pull request May 8, 2024
)

Documentation wording taken from the
withdrawn PEP 558 (which had switched to the
Python level semantics proposed in PEP 667 prior
to its withdrawal).
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.

2 participants