Skip to content

gh-95913: Edit Faster CPython section in 3.11 WhatsNew#98429

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.

Sign up for GitHub

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

Jump to bottom
Merged
Fidget-Spinner merged 8 commits into from
Mar 7, 2023
Merged

gh-95913: Edit Faster CPython section in 3.11 WhatsNew #98429

Fidget-Spinner merged 8 commits into from
Mar 7, 2023

Conversation

@CAM-Gerlach
Copy link
Member

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

Part of #95913

This PR cross-references, sphinxifies and copyedits the Faster CPython section of the What's New in Python 3.11 document. Specifically, it:

  • Converts the FAQ from a manually formatted static block to standard, linkable headings and ref target labels
  • Adds Sphinx roles and cross references to the appropriate constructs missing them
  • Fixes and refines reST syntax
  • Refines some of the writing to improve readability and reduce choppiness
  • Fixes/tweaks a few other minor textual issues

Notably, it takes care not to make any substantive additions/changes to the actual content, to expedite review, as it already was assumed to be reasonably complete

@bedevere-botbedevere-bot added awaiting review docs Documentation in the Doc dir skip news labels Oct 19, 2022
@CAM-GerlachCAM-Gerlachforce-pushed the whatsnew-faster-cpython branch from dced4fa to 3d614eeCompareOctober 19, 2022 04:31
@CAM-GerlachCAM-Gerlach added 3.11 only security fixes needs backport to 3.11 only security fixes labels Oct 19, 2022
@CAM-GerlachCAM-Gerlach mentioned this pull request Oct 19, 2022
Closed
33 tasks
@Fidget-SpinnerFidget-Spinner self-requested a review October 19, 2022 11:32
Fidget-Spinner
Fidget-Spinner reviewed Oct 19, 2022
View reviewed changes
Copy link
Member

@Fidget-SpinnerFidget-Spinner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good in general.

@CAM-Gerlach@Fidget-Spinner
Apply textual clarifications from Ken Jin
6fe84e8
Co-authored-by: Ken Jin <kenjin@python.org>
@CAM-GerlachCAM-Gerlach mentioned this pull request Oct 19, 2022
Merged
@CAM-Gerlach
Copy link
MemberAuthor

CAM-Gerlach commented Mar 6, 2023

Hey @Fidget-Spinner , did you get a chance to give this another look?

@Fidget-Spinner
Copy link
Member

Fidget-Spinner commented Mar 6, 2023

Oh gosh I'm so sorry that I forgot about this. Thanks for the ping.

@Fidget-Spinner@CAM-Gerlach
LOAD_GLOBAL without call
0e898cd
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
Fidget-Spinner
Fidget-Spinner reviewed Mar 6, 2023
View reviewed changes
Doc/whatsnew/3.11.rst
others have sped up by nearly 2x!


.. _faster-cpython-jit:
Copy link
Member

@Fidget-SpinnerFidget-SpinnerMar 6, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just for my own understanding, these are so that the hyperlink generates nicer links right?

Copy link
MemberAuthor

@CAM-GerlachCAM-GerlachMar 6, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are ref target labels, which allow directly and stably linking and cross-referencing of this FAQ answer using the :ref: role (:ref:`faster-cypthon-jit`), both within this document (as with implicit hyperlinks, but much more robustly), but also from anywhere else within the CPython documentation, and also from any other docs that links to this one via Intersphinx (as many do). This reference will continue to work even if this section is later moved, renamed, combined with another section, split into multiple, etc.

Furthermore, it means external links to this fragment id (i.e. using #faster-cpython-jit) will continue to work if the section is renamed on the same page, and it also allows automatically setting up external-link redirects to different pages via some tooling I'm working on. Finally, if it were to break for whatever reason, it will generate an optional warning rather than simply breaking silently.

@Fidget-SpinnerFidget-Spinner merged commit 80b19a3 into python:mainMar 7, 2023
@miss-islington
Copy link
Contributor

miss-islington commented Mar 7, 2023

Thanks @CAM-Gerlach for the PR, and @Fidget-Spinner for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11.
🐍🍒⛏🤖

@bedevere-bot
Copy link

bedevere-bot commented Mar 7, 2023

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

@bedevere-botbedevere-bot removed the needs backport to 3.11 only security fixes label Mar 7, 2023
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Mar 7, 2023
@CAM-Gerlach@miss-islington
pythongh-95913: Edit Faster CPython section in 3.11 WhatsNew (pythonG…
1adcd12
…H-98429) (cherry picked from commit 80b19a3) Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
Fidget-Spinner pushed a commit that referenced this pull request Mar 7, 2023
@miss-islington@CAM-Gerlach
[3.11]gh-95913: Edit Faster CPython section in 3.11 WhatsNew (GH-98429…
df3ed54
…) (GH-102490) gh-95913: Edit Faster CPython section in 3.11 WhatsNew (GH-98429) (cherry picked from commit 80b19a3) Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
carljm added a commit to carljm/cpython that referenced this pull request Mar 7, 2023
@carljm
Merge branch 'main' into nodeaddict
e391218
* main: pythongh-102493: fix normalization in PyErr_SetObject (python#102502) pythongh-87092: compiler's CFG construction moved to after codegen stage (python#102320) pythongh-95913: Consolidate build requirements changes in 3.11 WhatsNew (pythonGH-98781) Remove redundant `_ensure_future` in favor of `ensure_future` in `asyncio` (python#102398) pythongh-95913: Edit Faster CPython section in 3.11 WhatsNew (pythonGH-98429) pythongh-90110: Fix the c-analyzer Tool (python#102483) pythongh-101759: Update macOS installer SQLite 3.40.1 checksum (pythongh-102485) Remove unused import of `warnings` from `unittest.loader` (python#102479) Add gettext support to tools/extensions/c_annotations.py (python#101989)
carljm added a commit to carljm/cpython that referenced this pull request Mar 8, 2023
@carljm
Merge branch 'main' into inlinecomp2
1c019a7
* main: pythongh-102493: fix normalization in PyErr_SetObject (python#102502) pythongh-87092: compiler's CFG construction moved to after codegen stage (python#102320) pythongh-95913: Consolidate build requirements changes in 3.11 WhatsNew (pythonGH-98781) Remove redundant `_ensure_future` in favor of `ensure_future` in `asyncio` (python#102398) pythongh-95913: Edit Faster CPython section in 3.11 WhatsNew (pythonGH-98429) pythongh-90110: Fix the c-analyzer Tool (python#102483) pythongh-101759: Update macOS installer SQLite 3.40.1 checksum (pythongh-102485) Remove unused import of `warnings` from `unittest.loader` (python#102479) Add gettext support to tools/extensions/c_annotations.py (python#101989)
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Fidget-SpinnerFidget-SpinnerFidget-Spinner approved these changes

@markshannonmarkshannonAwaiting requested review from markshannon

Assignees

No one assigned

Labels

3.11only security fixesdocsDocumentation in the Doc dirskip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@CAM-Gerlach@Fidget-Spinner@miss-islington@bedevere-bot