Skip to content

PEP 788: Minor editorial fixes #4477

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

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

ZeroIntensity
Copy link
Member

@ZeroIntensity ZeroIntensity commented Jul 1, 2025

  • Change is either:
    • To a Draft PEP
    • To an Accepted or Final PEP, with Steering Council approval
    • To fix an editorial issue (markup, typo, link, header, etc)
  • PR title prefixed with PEP number (e.g. PEP 123: Summary of changes)

Addresses Petr's editorial comments, apart from the PEP title. I'm not sure it's a good idea to change the title at this point.


📚 Documentation preview 📚: https://pep-previews--4477.org.readthedocs.build/pep-0788/

@ZeroIntensity ZeroIntensity requested a review from encukou July 1, 2025 00:01
@ZeroIntensity ZeroIntensity requested a review from vstinner as a code owner July 1, 2025 00:01
Copy link
Member

@encukou encukou left a comment

Choose a reason for hiding this comment

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

Thanks! LGTM except the porting guide.

Comment on lines 665 to 666
There are two ``PyGILState`` APIs that act as an abstraction for
:term:`thread states <thread state>`. For some background, Python stores
Copy link
Member

Choose a reason for hiding this comment

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

What I mean by “porting guide” is concrete steps to do when the compiler gives you deprecation warnings. No background and theory, and as few assumptions as possible about the reader knowing what the code in question does (i.e. if there's a purely mechanical replacement, write that; otherwise list alternatives and say how to choose between them; and say what to watch out for.)
Here's one I wrote recently: https://peps.python.org/pep-0793/#porting-guide

(A porting guide doesn't need to be in the PEP, but it should be in the final docs. Might be best to remove it from this PR.)

Copy link
Member Author

Choose a reason for hiding this comment

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

Ok, let's remove it for now. We can circle back to it later.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants