-
-
Notifications
You must be signed in to change notification settings - Fork 31.4k
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-95913: Edit & expand Deprecated section of 3.11 WhatsNew #98581
gh-95913: Edit & expand Deprecated section of 3.11 WhatsNew #98581
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.
Looks great. Thanks for taking the time to do this work. Did I miss an expected step when enacting the deprecation, or is this process working as expected?
The RMs are the ultimate authority, and I'm no authority at all, but at least nowadays, per the devguide and in general practice, it seems the What's New entry is supposed to be written as part of the deprecation PR. This it ensures it is prompt, accurate and doesn't fall through the cracks. I believe in the past, though, this may not have always been the case (based on the comments in the What's New document), and there was more responsibility on the RMs to trawl through the Changelog and write up items they thought were significant enough. In any case, thanks to the use of the |
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.
Looks good, one wording suggestion
Thanks @CAM-Gerlach for the PR, and @JelleZijlstra for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11. |
…thonGH-98581) * Refine Sphinx syntax and grammar/phrasing in Deprecated section items * Organize into lang/builtins, modules & stdlib sections * Convert PEP 594 module list into a grid to not waste as much space * Add importlib.resources deprecated functions to section (cherry picked from commit dfb5d27) Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
GH-98598 is a backport of this pull request to the 3.11 branch. |
* Refine Sphinx syntax and grammar/phrasing in Deprecated section items * Organize into lang/builtins, modules & stdlib sections * Convert PEP 594 module list into a grid to not waste as much space * Add importlib.resources deprecated functions to section (cherry picked from commit dfb5d27) Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
Part of #95913
This PR copyedits, Sphinxifies, organizes and formats the Deprecated (Python) section in the Python 3.11 What's New. Specifically, it:
Also, searching through deprecation warnings in the docs, I found one set of deprecations that weren't documented in the What's New, and did so:
importlib.resources
deprecated its original set of functions added in 3.7 and supplanted by improved alternatives in 3.9. However, that hadn't been mentioned in the What's New anywhere I could find, so I added a short description and enumerated the relevant functions.There may be more in the changelog that aren't properly documented in the docs, but if so that can wait for a followup.