Skip to content
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

Merged
merged 5 commits into from
Oct 24, 2022

Conversation

CAM-Gerlach
Copy link
Member

@CAM-Gerlach CAM-Gerlach commented Oct 24, 2022

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 bedevere-bot added awaiting review docs Documentation in the Doc dir skip news labels Oct 24, 2022
@CAM-Gerlach CAM-Gerlach added 3.11 only security fixes needs backport to 3.11 only security fixes labels Oct 24, 2022
@CAM-Gerlach CAM-Gerlach requested a review from pablogsal October 24, 2022 02:48
@CAM-Gerlach CAM-Gerlach mentioned this pull request Oct 24, 2022
33 tasks
Copy link
Member

@jaraco jaraco left a 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?

@CAM-Gerlach
Copy link
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.

Copy link
Member

@JelleZijlstra JelleZijlstra left a 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

@JelleZijlstra JelleZijlstra merged commit dfb5d27 into python:main Oct 24, 2022
@miss-islington
Copy link
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
…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
Copy link

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

@bedevere-bot 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
* 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3.11 only security fixes docs Documentation in the Doc dir skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants