GeezerVison

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

GeezerVison is showing github.com — gh-95913: Fix and copyedit New Features section of 3.11 What's New by CAM-Gerlach · Pull Request #95915 · python/cpython

Conversation

CAM-Gerlach commented Aug 12, 2022 •

edited

Loading

Uh oh!

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

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

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

bedevere-bot added docs

Documentation in the Doc dir

skip news awaiting review labels

Aug 12, 2022

CAM-Gerlach requested review from ezio-melotti, iritkatriel and pablogsal

August 12, 2022 06:06

CAM-Gerlach mentioned this pull request

Aug 12, 2022

Edit What's New for Python 3.11 #95913

Closed

31 of 33 tasks

ezio-melotti reviewed

Aug 12, 2022

View reviewed changes

Comment thread

Doc/whatsnew/3.11.rst

Comment on lines +106 to 130

		when dealing with deeply nested :class:`dict` objects and multiple function calls:

		.. code-block:: python

ezio-melotti Aug 12, 2022

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.

Can't we use this here?

Suggested change

	when dealing with deeply nested :class:`dict` objects and multiple function calls:

	.. code-block:: python
	when dealing with deeply nested :class:`dict` objects and multiple function calls::

Sorry, something went wrong.

Uh oh!

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

All reactions

CAM-Gerlach Aug 14, 2022

Copy link

Copy Markdown

Member Author

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.

I didn't see a strong reason to change this from the original source, since it renders equivalently, is a little more explicit and (IIRC) warns if the syntax used doesn't actually lex according to the declared lexer (vs. :: fails silently). But I can if you think its important

Sorry, something went wrong.

Uh oh!

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

All reactions

Comment thread

Doc/c-api/code.rst

		.. index:: object; code, code object

		.. _codeobjects:

ezio-melotti Aug 12, 2022

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.

How does this change affect :ref: and index entries linking (if it does)?

Sorry, something went wrong.

Uh oh!

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

All reactions

CAM-Gerlach Aug 14, 2022

Copy link

Copy Markdown

Member Author

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.

It doesn't affect the index entries (it still links to the same place, right above the section) but fixes an issue with the ref target not actually being the section as intended, and thus not having a generated link text causing :ref:`codeobjects` to error out. It won't affect any existing refs, since it only changes the generated link text and not the ref target location, which the existing refs could not be using or they would have errored and failed the build.

Sorry, something went wrong.

Uh oh!

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

All reactions

Comment thread

Doc/whatsnew/3.11.rst

Comment on lines +124 to 148

		As well as complex arithmetic expressions:

		.. code-block:: python

ezio-melotti Aug 12, 2022

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.

Suggested change

	As well as complex arithmetic expressions:

	.. code-block:: python
	As well as complex arithmetic expressions::

Same here, and possibly elsewhere.

Sorry, something went wrong.

Uh oh!

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

All reactions

CAM-Gerlach Aug 14, 2022

Copy link

Copy Markdown

Member Author

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.

See above—I can do this if you really think its necessary, but I'm not sure it is.

Sorry, something went wrong.

Uh oh!

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

All reactions

Comment thread

Doc/whatsnew/3.11.rst Resolved

Uh oh!

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

Comment thread

Doc/whatsnew/3.11.rst Outdated

		that is not available at the time when the exception is raised.
		The added notes appear in the default traceback.
		See :pep:`678` for more details.
		(Contributed by Irit Katriel in :issue:`45607`.)

ezio-melotti Aug 12, 2022

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.

Suggested change

	(Contributed by Irit Katriel in :issue:`45607`.)
	(Contributed by Irit Katriel in :gh:`89770`.)

Sorry, something went wrong.

Uh oh!

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

All reactions

CAM-Gerlach Aug 14, 2022

Copy link

Copy Markdown

Member Author

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.

I thought about this, but I didn't end up updating these, since the BPO issue was canonical at the time the work was done, and the links redirect to the up to date GH issue. Is there any guidance on whether old :issue: refs should be manually converted, or left as-is? I couldn't find any in the devguide; if not, it might be better to make this a separate issue/discussion and be done consistently throughout.

Sorry, something went wrong.

Uh oh!

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

All reactions

encukou Sep 19, 2022

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.

IMO it's best to avoid links to redirects, but it's not a big deal.

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

CAM-Gerlach Sep 19, 2022 •

edited

Loading

Uh oh!

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

Copy link

Copy Markdown

Member Author

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.

Yup, if people agree I'm happy to go through and convert them; I just think its best to do it in a separate PR after these more important ones are all merged, so it can be decided there, its consistent and we don't hold up the rest of the changes since we're on the clock here.

Sorry, something went wrong.

Uh oh!

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

All reactions

Comment thread

Doc/whatsnew/3.11.rst

		- The :c:func:`PyCode_Addr2Location` function in the C API.

		See :pep:`657` for more details. (Contributed by Pablo Galindo, Batuhan Taskaya
		and Ammar Askar in :issue:`43950`.)

ezio-melotti Aug 12, 2022

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.

Suggested change

	and Ammar Askar in :issue:`43950`.)
	and Ammar Askar in :gh:`88116`.)

Sorry, something went wrong.

Uh oh!

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

All reactions

CAM-Gerlach Aug 14, 2022

Copy link

Copy Markdown

Member Author

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.

See above

Sorry, something went wrong.

Uh oh!

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

All reactions

iritkatriel commented Aug 12, 2022

Copy link

Copy Markdown

Member

Approved the pep 678 related edits.

CAM-Gerlach reacted with hooray emoji

All reactions

🎉 1 reaction

Sorry, something went wrong.

Uh oh!

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

CAM-Gerlach mentioned this pull request

Aug 13, 2022

gh-95914: Add paragraph about PEP 654 in main body of 'What's New in 3.11' #95937

Merged

Fidget-Spinner self-requested a review

August 13, 2022 03:43

CAM-Gerlach and others added 5 commits

August 14, 2022 02:19


          3.11 Whatsnew: Revise desc of enhanced error locations feature

d0e8c28


          3.11 Whatsnew: Combine error locations sections to avoid duplication

7dacbbf


          3.11 Whatsnew: Copyedit section describing exception notes

548e6c7


          pythongh-95914: Add to What's New a credit for PEP 678 author

81add60


          Add standardized ref links to sections

3c4a03a

CAM-Gerlach force-pushed the whatsnew-copyedit-new-features branch from c6e9c6d to 3c4a03a Compare

August 14, 2022 07:38

CAM-Gerlach added the needs backport to 3.11 only security fixes label

Aug 14, 2022

CAM-Gerlach requested a review from ezio-melotti

August 14, 2022 07:40

CAM-Gerlach mentioned this pull request

Aug 14, 2022

gh-95914: Add to what's new a credit for pep 678 author #95955

Closed

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

All reactions

Sorry, something went wrong.

Uh oh!

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

Fidget-Spinner commented Aug 14, 2022

Copy link

Copy Markdown

Member

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

All reactions

Sorry, something went wrong.

Uh oh!

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

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.

All reactions

Sorry, something went wrong.

Uh oh!

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

encukou merged commit 8ee27e3 into python:main

Sep 19, 2022

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

All reactions

Sorry, something went wrong.

Uh oh!

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

bedevere-bot removed awaiting review needs backport to 3.11 only security fixes labels

Sep 19, 2022

bedevere-bot commented Sep 19, 2022

Copy link

Copy Markdown

GH-96933 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.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request

Sep 19, 2022


          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 <[email protected]>

miss-islington added a commit that referenced this pull request

Sep 19, 2022


          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 <[email protected]>

CAM-Gerlach mentioned this pull request

Sep 19, 2022

List and document remaining significant PEPs in What's New in 3.11 #95914

Closed

5 tasks done

CAM-Gerlach mentioned this pull request

Oct 2, 2022

gh-95913: Fix PEP number in PEP 678 What's New ref label #97739

Merged

pablogsal pushed a commit that referenced this pull request

Oct 22, 2022


          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 <[email protected]>

Reviewers

encukou

encukou left review comments

pablogsal

Awaiting requested review from pablogsal

iritkatriel

Awaiting requested review from iritkatriel

Fidget-Spinner

Awaiting requested review from Fidget-Spinner

ezio-melotti

Awaiting requested review from ezio-melotti

Uh oh!

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

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.

Uh oh!

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

7 participants

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.

Conversation

CAM-Gerlach commented Aug 12, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

CAM-Gerlach Sep 19, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

iritkatriel commented Aug 12, 2022

Uh oh!

CAM-Gerlach commented Aug 14, 2022

Uh oh!

Fidget-Spinner commented Aug 14, 2022

Uh oh!

encukou commented Sep 19, 2022

Uh oh!

miss-islington commented Sep 19, 2022

Uh oh!

bedevere-bot commented Sep 19, 2022

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

CAM-Gerlach commented Aug 12, 2022 •

edited

Loading

Uh oh!

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

CAM-Gerlach Sep 19, 2022 •

edited

Loading

Uh oh!

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