◐ Shell
reader mode source ↗
Skip to content

gh-95913: Copyedit, link & format Typing Features section in 3.11 What's New#96097

Merged
encukou merged 8 commits into
python:mainfrom
CAM-Gerlach:whatsnew-copyedit-typing-features
Sep 19, 2022
Merged

gh-95913: Copyedit, link & format Typing Features section in 3.11 What's New#96097
encukou merged 8 commits into
python:mainfrom
CAM-Gerlach:whatsnew-copyedit-typing-features

Conversation

@CAM-Gerlach

@CAM-Gerlach CAM-Gerlach commented Aug 19, 2022 •
edited by bedevere-bot
Loading

Copy link
Copy Markdown
Member

Part of #95913

Fixes Sphinx and textual issues in the What's New in Python 3.11 "New Features Related to Type Hints" section, improves the clarity, quality and non-duplication of the text, and links to referenced documentation sections.

Non-trivial highlights:

  • Split PEP 646 description into two paragraphs for easier readability
  • Clarify the syntax and semantics of the description of the interaction of total and required
  • Link the PEP 484 section implicitly referred by PEP 673 directly, as its quite non-trivial to find
  • Use a more Pythonically (and perhaps culturally) first/last name in PEP 681 example
  • Clarify PEP 563 status description, particularly that this is not the first deferral, the more common form as well as a link to the __future__ statement, and make the link text more descriptive

General changes:

  • Add Sphinx cross-references to additional items
  • Clarify the text in various spots
  • Fix/improve a number of other minor grammar, punctuation and phrasing issues
  • Consistent section heading capitalization, ref target labels and spacing

@CAM-Gerlach CAM-Gerlach marked this pull request as draft August 19, 2022 02:59
@CAM-Gerlach CAM-Gerlach force-pushed the whatsnew-copyedit-typing-features branch from 69dd4fd to dc75401 Compare August 19, 2022 03:01
@CAM-Gerlach CAM-Gerlach marked this pull request as ready for review August 19, 2022 03:02
@CAM-Gerlach CAM-Gerlach changed the title gh-95913: Copyedit, link & format New Typing Features section in 3.11 What's New Aug 19, 2022
@CAM-Gerlach CAM-Gerlach mentioned this pull request Aug 19, 2022
Closed
33 tasks
JelleZijlstra
JelleZijlstra reviewed Aug 19, 2022
View reviewed changes

@JelleZijlstra 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.

Hide comment

Thanks, mostly looks good!

@CAM-Gerlach @ezio-melotti @AlexWaygood
Apply further reviewer textual suggestions …
346a23f 
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
AlexWaygood
AlexWaygood approved these changes Aug 20, 2022
View reviewed changes

@AlexWaygood AlexWaygood 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.

Hide comment

Thanks! I still don't really think there's a good rationale for changing # error to # ERROR, but that's a minor nit :)

@CAM-Gerlach CAM-Gerlach added the needs backport to 3.11 only security fixes label Aug 20, 2022
23 hidden items Load more…
@encukou

encukou commented Sep 19, 2022

Copy link
Copy Markdown
Member

Merging, the minor nit can be resolved later.

@encukou encukou merged commit 558768f into python:main Sep 19, 2022
@miss-islington

miss-islington commented Sep 19, 2022

Copy link
Copy Markdown
Contributor

Thanks @CAM-Gerlach for the PR, and @encukou 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 Sep 19, 2022
@CAM-Gerlach @miss-islington
pythongh-95913: Copyedit, link & format Typing Features section in 3.… …
e678672 
…11 What's New (pythonGH-96097)

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
(cherry picked from commit 558768f)

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

bedevere-bot commented Sep 19, 2022

Copy link
Copy Markdown

GH-96934 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 Sep 19, 2022
miss-islington added a commit that referenced this pull request Sep 19, 2022
@miss-islington @CAM-Gerlach
gh-95913: Copyedit, link & format Typing Features section in 3.11 Wha… …
bda451b 
…t's New (GH-96097)

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
(cherry picked from commit 558768f)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
@CAM-Gerlach CAM-Gerlach mentioned this pull request Sep 19, 2022
Closed
5 tasks
pablogsal pushed a commit that referenced this pull request Oct 22, 2022
@miss-islington @CAM-Gerlach @pablogsal
gh-95913: Copyedit, link & format Typing Features section in 3.11 Wha… …
837c120 
…t's New (GH-96097)

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
(cherry picked from commit 558768f)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
pablogsal pushed a commit that referenced this pull request Oct 22, 2022
@miss-islington @CAM-Gerlach @pablogsal
gh-95913: Copyedit, link & format Typing Features section in 3.11 Wha… …
a1e59b7 
…t's New (GH-96097)

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
(cherry picked from commit 558768f)

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

Reviewers

@encukou encukou

@JelleZijlstra JelleZijlstra JelleZijlstra left review comments

@ezio-melotti ezio-melotti ezio-melotti left review comments

@AlexWaygood AlexWaygood AlexWaygood approved these changes

@pablogsal pablogsal Awaiting requested review from pablogsal

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

@CAM-Gerlach @encukou @miss-islington @bedevere-bot @JelleZijlstra @ezio-melotti @AlexWaygood