Skip to content

gh-137352: Add terms links to dis.rst#137787

Open
Tapeline wants to merge 4 commits intopython:mainfrom
Tapeline:gh-137352-dis-term-links
Open

gh-137352: Add terms links to dis.rst#137787
Tapeline wants to merge 4 commits intopython:mainfrom
Tapeline:gh-137352-dis-term-links

Conversation

@Tapeline
Copy link
Copy Markdown
Contributor

@Tapeline Tapeline commented Aug 14, 2025 •
edited by github-actions bot
Loading

@bedevere-app bedevere-app bot added the docs Documentation in the Doc dir label Aug 14, 2025
@github-project-automation github-project-automation bot moved this to Todo in Docs PRs Aug 14, 2025
@bedevere-app bedevere-app bot mentioned this pull request Aug 14, 2025
Open
StanFromIreland
StanFromIreland reviewed Aug 15, 2025
View reviewed changes
Misc/NEWS.d/next/Documentation/2025-08-15-01-28-04.gh-issue-137352.PMvwxi.rst Outdated
@@ -0,0 +1 @@
Add links to glossary terms in ``dis.rst``.
Copy link
Copy Markdown
Member

@StanFromIreland StanFromIreland Aug 15, 2025

Choose a reason for hiding this comment

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

Blurbs are not necessary for Docs changes.

StanFromIreland
StanFromIreland reviewed Aug 15, 2025
View reviewed changes
Copy link
Copy Markdown
Member

@StanFromIreland StanFromIreland left a comment

Choose a reason for hiding this comment

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

Please remember to not over link, you can find more on this topic in the devguide.

@Eclips4 Eclips4 added skip news needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes labels Aug 30, 2025
@Tapeline Tapeline marked this pull request as ready for review August 30, 2025 18:56
@Tapeline
Copy link
Copy Markdown
Contributor Author

Tapeline commented Mar 26, 2026

@StanFromIreland
Hello, can we get this PR merged? :)

Regarding your comment

Please remember to not over link, you can find more on this topic in the devguide.

The guide is quite vague:

Generally, a link should be provided for the first use of a term in a unit, such as a section or paragraph. This is not a hard and fast rule. Sometimes the second mention is more appropriate for a link. Some units are long enough to have a few repeated links. Use judgement to decide when a link will help the reader.

I tried my best to not overlink whilst maintaining links to terms easily findable

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@StanFromIreland StanFromIreland StanFromIreland left review comments

Assignees

No one assigned

Labels

awaiting review docs Documentation in the Doc dir needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes skip news

Projects

Docs PRs
Status: Todo

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@Tapeline @StanFromIreland @Eclips4