← 返回首页
gh-95913: Edit & expand Deprecated section of 3.11 WhatsNew by CAM-Gerlach · Pull Request #98581 · python/cpython · GitHub
Skip to content

Navigation Menu

Toggle navigation
Sign in
Appearance settings
Search or jump to...

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

Provide feedback

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

Include my email address so I can be contacted
Cancel Submit feedback

Saved searches

Use saved searches to filter your results more quickly

Cancel Create saved search
Appearance settings
Resetting focus

gh-95913: Edit & expand Deprecated section of 3.11 WhatsNew#98581

Merged
JelleZijlstra merged 5 commits into
python:mainfrom
CAM-Gerlach:whatsnew-edit-deprecated
Oct 24, 2022
Merged

gh-95913: Edit & expand Deprecated section of 3.11 WhatsNew#98581
JelleZijlstra merged 5 commits into
python:mainfrom
CAM-Gerlach:whatsnew-edit-deprecated

Conversation

CAM-Gerlach commented Oct 24, 2022 •
edited
Loading

Copy link
Copy Markdown
Member

Part of #95913

This PR copyedits, Sphinxifies, organizes and formats the Deprecated (Python) section in the Python 3.11 What's New. Specifically, it:

  • Organizes the section from a long, flat, essentially arbitrary list of items to be ordered by Language/Builtin deprecations, then whole Module deprecation, and finally deprecations in the stdlib, sorted alphabetically. This puts the broader-reaching changes nearer the top and makes it much easier for readers to navigate and find particular areas/deprecations they are interested in.
  • Formats the listing of PEP 594-removed modules from a long thin bulleted list to a table, to take up much less space while being easier to skim at a glance
  • Tweaks the text to fix grammar and phrasing errors and issues
  • Fixes and enhances the Sphinx cross-references and reST syntax used

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.

bedevere-bot added awaiting review docs Documentation in the Doc dir skip news labels Oct 24, 2022
CAM-Gerlach added 3.11 only security fixes needs backport to 3.11 only security fixes labels Oct 24, 2022
CAM-Gerlach requested a review from pablogsal October 24, 2022 02:48
CAM-Gerlach mentioned this pull request Oct 24, 2022
Closed
33 tasks
jaraco approved these changes Oct 24, 2022
View reviewed changes

jaraco left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality Hide comment

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?

CAM-Gerlach commented Oct 24, 2022

Copy link
Copy Markdown
Member Author

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 deprecated/deprecated-removed directive and detailed-enough documentation, I was able to find and write it without too much trouble.

JelleZijlstra reviewed Oct 24, 2022
View reviewed changes

JelleZijlstra left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality Hide comment

Looks good, one wording suggestion

Comment thread Doc/whatsnew/3.11.rst Outdated Show resolved Hide resolved
JelleZijlstra merged commit dfb5d27 into python:main Oct 24, 2022

miss-islington commented Oct 24, 2022

Copy link
Copy Markdown
Contributor

Thanks @CAM-Gerlach for the PR, and @JelleZijlstra for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Oct 24, 2022
pythongh-95913: Edit & expand Deprecated section of 3.11 WhatsNew (py… …
c7a6760
…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>

bedevere-bot commented Oct 24, 2022

Copy link
Copy Markdown

GH-98598 is a backport of this pull request to the 3.11 branch.

bedevere-bot removed the needs backport to 3.11 only security fixes label Oct 24, 2022
miss-islington added a commit that referenced this pull request Oct 24, 2022
gh-95913: Edit & expand Deprecated section of 3.11 WhatsNew (GH-98581) …
3aed2ac
* 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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

JelleZijlstra JelleZijlstra left review comments
jaraco jaraco approved these changes
ezio-melotti Awaiting requested review from ezio-melotti
pablogsal Awaiting requested review from pablogsal

Assignees

No one assigned

Labels

3.11 only security fixes docs Documentation in the Doc dir skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

Footer

© 2026 GitHub, Inc.