-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
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
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this 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.
peps/pep-0788.rst
Outdated
There are two ``PyGILState`` APIs that act as an abstraction for | ||
:term:`thread states <thread state>`. For some background, Python stores |
There was a problem hiding this comment.
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.)
There was a problem hiding this comment.
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.
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/