◐ Shell
reader mode source ↗
Skip to content

gh-95913: Fix and copyedit New Features section of 3.11 What's New#95915

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

gh-95913: Fix and copyedit New Features section of 3.11 What's New#95915
encukou merged 5 commits into
python:mainfrom
CAM-Gerlach:whatsnew-copyedit-new-features

Conversation

@CAM-Gerlach

@CAM-Gerlach CAM-Gerlach commented Aug 12, 2022 •
edited
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" section, improves the clarity, quality and non-duplication of the text, and links to referenced documentation sections.

Nothing too major, but a few highlights:

  • Consolidate the traceback location API section with the rest of the exception location section, to avoid significant duplication of nearly half the section's contents between them
  • Fix the heading level of the "Exception notes" feature description; it was mistakenly under the "Exact Error Locations" section
  • Fix a broken reference to the critical BaseException.add_note() method
  • Sphinx-link to referenced items, including code objects, bytecode definition and bytecode instructions
  • Fix/improve a number of other minor grammar, punctuation and phrasing issues

@bedevere-bot bedevere-bot added docs Documentation in the Doc dir skip news awaiting review labels Aug 12, 2022
@CAM-Gerlach CAM-Gerlach mentioned this pull request Aug 12, 2022
Closed
33 tasks
@iritkatriel

iritkatriel commented Aug 12, 2022

Copy link
Copy Markdown
Member

Approved the pep 678 related edits.

@CAM-Gerlach CAM-Gerlach mentioned this pull request Aug 13, 2022
Merged
@Fidget-Spinner Fidget-Spinner self-requested a review August 13, 2022 03:43
@CAM-Gerlach CAM-Gerlach force-pushed the whatsnew-copyedit-new-features branch from c6e9c6d to 3c4a03a Compare August 14, 2022 07:38
@CAM-Gerlach CAM-Gerlach added the needs backport to 3.11 only security fixes label Aug 14, 2022
@CAM-Gerlach CAM-Gerlach mentioned this pull request Aug 14, 2022
Closed
@CAM-Gerlach

CAM-Gerlach commented Aug 14, 2022

Copy link
Copy Markdown
Member Author

Thanks @iritkatriel and sorry for the delay getting to this @ezio-melotti — I responded to the comments, fixed the conflict caused by #95937 changing the title of the next section, cherry-picked in @iritkatriel 's #95955 (to fix the conflicts with this), and added a commit adding consistent, standardized section ref labels to the touched sections.

Closes #95955

@Fidget-Spinner

Fidget-Spinner commented Aug 14, 2022

Copy link
Copy Markdown
Member

LGTM other than the discussion about bpo vs GH issue linking being unresolved.

@encukou

encukou commented Sep 19, 2022

Copy link
Copy Markdown
Member

This is an improvement, so I'll merge it.
Issue linking can be fixed later.

@encukou encukou merged commit 8ee27e3 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.
🐍🍒⛏🤖

@bedevere-bot

bedevere-bot commented Sep 19, 2022

Copy link
Copy Markdown

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Sep 19, 2022
@CAM-Gerlach @miss-islington
pythongh-95913: Fix and copyedit New Features section of 3.11 What's … …
91446f3 
…New (pythonGH-95915)

(cherry picked from commit 8ee27e3)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
miss-islington added a commit that referenced this pull request Sep 19, 2022
@miss-islington @CAM-Gerlach
gh-95913: Fix and copyedit New Features section of 3.11 What's New (G… …
58247c5 
…H-95915)

(cherry picked from commit 8ee27e3)

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
@CAM-Gerlach CAM-Gerlach mentioned this pull request Oct 2, 2022
Merged
pablogsal pushed a commit that referenced this pull request Oct 22, 2022
@miss-islington @CAM-Gerlach @pablogsal
gh-95913: Fix and copyedit New Features section of 3.11 What's New (G… …
365f9b7 
…H-95915)

(cherry picked from commit 8ee27e3)

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 encukou left review comments

@pablogsal pablogsal Awaiting requested review from pablogsal

@iritkatriel iritkatriel

@Fidget-Spinner Fidget-Spinner Awaiting requested review from Fidget-Spinner

@ezio-melotti ezio-melotti Awaiting requested review from ezio-melotti

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 @iritkatriel @Fidget-Spinner @encukou @miss-islington @bedevere-bot @ezio-melotti