Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

gh-74929: PEP 667 general docs update#119201

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged

Conversation

ncoghlan
Copy link
Contributor

@ncoghlanncoghlan commentedMay 20, 2024
edited
Loading

  • expand on What's New entry for PEP 667 (including porting notes)
  • review (and update) all mentions oflocals andf_locals in documentation
  • define "optimised scope" as a new glossary term

C API documentation updates will be added in a separate PR


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

* expand on What's New entry for PEP 667* review (and update) all mentions of "locals" in documentationC API documentation updates will be added in a separate PR
@ncoghlanncoghlan added docsDocumentation in the Doc dir 3.13bugs and security fixes 3.14bugs and security fixes needs backport to 3.13bugs and security fixes labelsMay 20, 2024
@ncoghlanncoghlan self-assigned thisMay 20, 2024
@ncoghlan
Copy link
ContributorAuthor

In addition to the inline notes in the PR, I also need to search for references tof_locals to see if any of those need changing.

@ncoghlanncoghlan marked this pull request as ready for reviewMay 20, 2024 10:26
@terryjreedy
Copy link
Member

Does the following refer to something other than thec-api/frame.rst changes?

C API documentation updates will be added in a separate PR

@terryjreedy
Copy link
Member

I did not see any grammar or spelling issues.

@jeremyhyltonjeremyhylton self-requested a reviewMay 20, 2024 18:49
Copy link
Contributor

@jeremyhyltonjeremyhylton left a comment

Choose a reason for hiding this comment

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

I left a handful of comments. Overall looks very good, but suggest a few minor revisions for clarity.

@ncoghlan
Copy link
ContributorAuthor

Does the following refer to something other than thec-api/frame.rst changes?

There are several C API additions and updates as described in the PEP. Most of them will be covered inframe.rst, but there are a fewPyEval_* changes to be covered elsewhere.

@ncoghlan
Copy link
ContributorAuthor

I realised that I was using the Aus/UK spelling ofoptimised, while the Python docs generally use US spelling (there were 300+ instances ofoptimized vs less than 20 uses ofoptimised, including the additions in this PR).

I also added an inline note to the glossary entry pointing out that most optimizations are applied to all scopes, there's just a subset that are only valid when the local and nonlocal variables names are known at compile time.

To avoid more conflicts with sprint changes, I will merge this version once CI is happy.

@ncoghlanncoghlanenabled auto-merge (squash)May 21, 2024 03:13
@ncoghlan
Copy link
ContributorAuthor

Capturing the commit message, just in case something fails before the auto-merge lands:

* expand on What's New entry for PEP 667 (including porting notes)* define 'optimized scope' as a glossary term* cover comprehensions and generator expressions in locals() docs* review all mentions of "locals" in documentation (updating if needed)* review all mentions of "f_locals" in documentation (updating if needed)

@ncoghlanncoghlan merged commite870c85 intopython:mainMay 21, 2024
@miss-islington-app
Copy link

Thanks@ncoghlan for the PR 🌮🎉.. I'm working now to backport this PR to: 3.13.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull requestMay 21, 2024
* expand on What's New entry for PEP 667 (including porting notes)* define 'optimized scope' as a glossary term* cover comprehensions and generator expressions in locals() docs* review all mentions of "locals" in documentation (updating if needed)* review all mentions of "f_locals" in documentation (updating if needed)(cherry picked from commite870c85)Co-authored-by: Alyssa Coghlan <ncoghlan@gmail.com>
@bedevere-app
Copy link

GH-119291 is a backport of this pull request to the3.13 branch.

@bedevere-appbedevere-appbot removed the needs backport to 3.13bugs and security fixes labelMay 21, 2024
estyxx pushed a commit to estyxx/cpython that referenced this pull requestJul 17, 2024
* expand on What's New entry for PEP 667 (including porting notes)* define 'optimized scope' as a glossary term* cover comprehensions and generator expressions in locals() docs* review all mentions of "locals" in documentation (updating if needed)* review all mentions of "f_locals" in documentation (updating if needed)
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@blaisepblaisepblaisep left review comments

@hugovkhugovkhugovk left review comments

@terryjreedyterryjreedyterryjreedy left review comments

@jeremyhyltonjeremyhyltonjeremyhylton left review comments

Assignees

@ncoghlanncoghlan

Labels
3.13bugs and security fixes3.14bugs and security fixesdocsDocumentation in the Doc dirskip news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

5 participants
@ncoghlan@terryjreedy@blaisep@hugovk@jeremyhylton

[8]ページ先頭

©2009-2025 Movatter.jp