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

Doc: Add missing ref labels to exception groups/notes sections #106465

Merged
merged 2 commits into from
Jul 6, 2023

Conversation

CAM-Gerlach
Copy link
Member

@CAM-Gerlach CAM-Gerlach commented Jul 5, 2023

Currently, the Exception Groups section of the library reference, and (more troublesomely, and unlike all the others there) the Enriching Exceptions with Notes tutorial sections are both missing ref targets labels, so it is not possible to reliably link them either internally or from other docs, PEPs, sites, etc. In particular, this blocks python/peps#3193 as it is not possible to add the required canonical-doc banners.

This PR fixes that by simply adding the relevant ref target labels accordingly.


📚 Documentation preview 📚: https://cpython-previews--106465.org.readthedocs.build/

@CAM-Gerlach CAM-Gerlach added docs Documentation in the Doc dir skip issue skip news 3.11 only security fixes 3.12 bugs and security fixes needs backport to 3.11 only security fixes 3.13 bugs and security fixes needs backport to 3.12 bug and security fixes labels Jul 5, 2023
@CAM-Gerlach CAM-Gerlach requested a review from hugovk July 5, 2023 20:36
Copy link
Member

@hugovk hugovk left a comment

Choose a reason for hiding this comment

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

Thank you!

@hugovk hugovk merged commit 38aa89a into python:main Jul 6, 2023
@miss-islington
Copy link
Contributor

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jul 6, 2023
…nGH-106465)

(cherry picked from commit 38aa89a)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
@bedevere-bot
Copy link

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

@bedevere-bot bedevere-bot removed the needs backport to 3.12 bug and security fixes label Jul 6, 2023
@bedevere-bot
Copy link

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

@bedevere-bot bedevere-bot removed the needs backport to 3.11 only security fixes label Jul 6, 2023
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jul 6, 2023
…nGH-106465)

(cherry picked from commit 38aa89a)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
hugovk pushed a commit that referenced this pull request Jul 6, 2023
hugovk pushed a commit that referenced this pull request Jul 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3.11 only security fixes 3.12 bugs and security fixes 3.13 bugs and security fixes docs Documentation in the Doc dir skip issue skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants