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, sort & expand 3.11 WhatsNew Porting section #98585

Merged
merged 4 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, sorts and fixes the syntax of the Porting section of the What's New in Python 3.11 document. In particular, it:

  • Orders the list alphabetically by module, with builtins at the top
  • Adds, fixes and refines Sphinx cross references
  • Adds appropriate Sphinx roles and other constructs
  • Tweaks the text to fix grammar/wording issues
  • Uses consistent, direct phrasing for easier/quicker readability

One item was added with this PR, based on grepping the docs, and one was removed:

  • The random parameter to random.shuffle being removed was added
  • A C API change mistakenly included in this section was removed, and will be added to the Porting section of the C API in a followup PR

There are likely a number of others that could be found by scouring the docs and changelog in detail, but I decided it was most pragmatic to defer that at least until later.

@bedevere-bot bedevere-bot added awaiting review docs Documentation in the Doc dir skip news labels Oct 24, 2022
@pablogsal pablogsal merged commit 43bef54 into python:main Oct 24, 2022
14 checks passed
@miss-islington
Copy link
Contributor

miss-islington commented Oct 24, 2022

Thanks @CAM-Gerlach for the PR, and @pablogsal 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-98585)

(cherry picked from commit 43bef54)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
@bedevere-bot
Copy link

bedevere-bot commented Oct 24, 2022

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

miss-islington added a commit that referenced this pull request Oct 24, 2022
(cherry picked from commit 43bef54)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
pablogsal pushed a commit that referenced this pull request Oct 24, 2022
(cherry picked from commit 43bef54)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
pablogsal pushed a commit that referenced this pull request Oct 24, 2022
(cherry picked from commit 43bef54)

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 docs Documentation in the Doc dir skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants