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 Faster CPython section in 3.11 WhatsNew #98429

Merged
merged 8 commits into from Mar 7, 2023

Conversation

CAM-Gerlach
Copy link
Member

@CAM-Gerlach CAM-Gerlach commented Oct 19, 2022

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-bot bedevere-bot added awaiting review docs Documentation in the Doc dir skip news labels Oct 19, 2022
Copy link
Member

@Fidget-Spinner Fidget-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.

Doc/whatsnew/3.11.rst Outdated Show resolved Hide resolved
Doc/whatsnew/3.11.rst Outdated Show resolved Hide resolved
Doc/whatsnew/3.11.rst Outdated Show resolved Hide resolved
Co-authored-by: Ken Jin <kenjin@python.org>
@CAM-Gerlach
Copy link
Member Author

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

@Fidget-Spinner
Copy link
Member

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

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
others have sped up by nearly 2x!


.. _faster-cpython-jit:
Copy link
Member

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
Member Author

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-Spinner Fidget-Spinner merged commit 80b19a3 into python:main Mar 7, 2023
15 checks passed
@miss-islington
Copy link
Contributor

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

GH-102490 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 Mar 7, 2023
…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
…) (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>
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