GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — gh-95913: Edit & expand Deprecated section of 3.11 WhatsNew by CAM-Gerlach · Pull Request #98581 · python/cpython

Conversation

@CAM-Gerlach

@CAM-Gerlach CAM-Gerlach commented Oct 24, 2022 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

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.

  • Issue: Edit What's New for Python 3.11 #95913

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
CAM-Gerlach added 4 commits October 23, 2022 20:22
@CAM-Gerlach
Refine Sphinx syntax and grammar/phrasing in Deprecated section items
fa50c3f
@CAM-Gerlach
Organize into lang/builtins, modules & stdlib sections
629177e
@CAM-Gerlach
Convert PEP 594 module list into a grid to not waste as much space
ce06ee6
@CAM-Gerlach
Add importlib.resources deprecated functions to section
b65e95d
@bedevere-bot bedevere-bot added awaiting review docs Documentation in the Doc dir skip news labels Oct 24, 2022
@CAM-Gerlach
CAM-Gerlach requested review from JelleZijlstra, ezio-melotti and jaraco October 24, 2022 02:43
@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
Edit What's New for Python 3.11 #95913
Closed
31 of 33 tasks
jaraco
jaraco approved these changes Oct 24, 2022
View reviewed changes

@jaraco jaraco left a comment

Copy link
Copy Markdown
Member

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?

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
CAM-Gerlach reacted with thumbs up emoji
All reactions
  • 👍 1 reaction
@bedevere-bot bedevere-bot added awaiting merge and removed awaiting review labels Oct 24, 2022
@CAM-Gerlach

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.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
JelleZijlstra
JelleZijlstra reviewed Oct 24, 2022
View reviewed changes

@JelleZijlstra JelleZijlstra left a comment

Copy link
Copy Markdown
Member

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
CAM-Gerlach reacted with thumbs up emoji
All reactions
  • 👍 1 reaction
Comment thread Doc/whatsnew/3.11.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
@JelleZijlstra
Update Doc/whatsnew/3.11.rst
1e86c67
@JelleZijlstra
JelleZijlstra merged commit dfb5d27 into python:main Oct 24, 2022
@miss-islington

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.
🐍🍒⛏🤖
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@bedevere-bot bedevere-bot removed the awaiting merge label Oct 24, 2022
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Oct 24, 2022
@CAM-Gerlach @miss-islington
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 <[email protected]>
@bedevere-bot

bedevere-bot commented Oct 24, 2022

Copy link
Copy Markdown

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@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
@miss-islington @CAM-Gerlach
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 <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

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

Uh oh!

There was an error while loading. Please reload this page.

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.

Uh oh!

There was an error while loading. Please reload this page.

5 participants

@CAM-Gerlach @miss-islington @bedevere-bot @jaraco @JelleZijlstra
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.