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-109190: What's New in 3.12: Add subheadings to removals for easy linking #109159

Merged
merged 5 commits into from
Sep 11, 2023

Conversation

hugovk
Copy link
Member

@hugovk hugovk commented Sep 8, 2023

Add subheadings to the Removed section.

Similar to Improved Modules, this gives us hyperlink anchors for the subheadings and makes it easy to share direct links. For example, I wanted to share a direct link to the ssl.match_hostname() removal, but had to use https://docs.python.org/3.12/whatsnew/3.12.html#removed which is a bit further away.

Before: https://docs.python.org/3.12/whatsnew/3.12.html#removed

After: https://cpython-previews--109159.org.readthedocs.build/en/109159/whatsnew/3.12.html#removed


📚 Documentation preview 📚: https://cpython-previews--109159.org.readthedocs.build/en/109159/whatsnew/3.12.html#removed

@hugovk hugovk added the docs Documentation in the Doc dir label Sep 8, 2023
@hugovk hugovk added skip issue needs backport to 3.12 bug and security fixes labels Sep 8, 2023
Copy link
Member

@AA-Turner AA-Turner left a comment

Choose a reason for hiding this comment

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

Good idea!

A

Doc/whatsnew/3.12.rst Outdated Show resolved Hide resolved
Doc/whatsnew/3.12.rst Outdated Show resolved Hide resolved
Doc/whatsnew/3.12.rst Show resolved Hide resolved
hugovk and others added 2 commits September 9, 2023 03:22
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@AA-Turner AA-Turner changed the title What's New in 3.12: Add subheadings to removals for easy linking gh-109190: What's New in 3.12: Add subheadings to removals for easy linking Sep 9, 2023
Doc/whatsnew/3.12.rst Outdated Show resolved Hide resolved
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@hugovk hugovk merged commit 57b6205 into python:main Sep 11, 2023
21 checks passed
@hugovk hugovk deleted the doc-whatsnew-3.12-removed-subheadings branch September 11, 2023 16:06
@miss-islington
Copy link
Contributor

Thanks @hugovk for the PR 🌮🎉.. I'm working now to backport this PR to: 3.12.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Sep 11, 2023
…easy linking (pythonGH-109159)

(cherry picked from commit 57b6205)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@bedevere-app
Copy link

bedevere-app bot commented Sep 11, 2023

GH-109273 is a backport of this pull request to the 3.12 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.12 bug and security fixes label Sep 11, 2023
Yhg1s pushed a commit that referenced this pull request Sep 12, 2023
… easy linking (GH-109159) (#109273)

gh-109190: What's New in 3.12: Add subheadings to removals for easy linking (GH-109159)
(cherry picked from commit 57b6205)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants