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

use page titles as link text to avoid warnings #1532

Merged
merged 2 commits into from
Mar 19, 2025

Conversation

nedbat
Copy link
Member

@nedbat nedbat commented Mar 18, 2025

Previously we had scary red messages:

devguide/core-developers/memorialization.rst:5: WARNING: Duplicate explicit target name: "here". [docutils]
devguide/core-developers/memorialization.rst:5: WARNING: Duplicate explicit target name: "here". [docutils]

📚 Documentation preview 📚: https://cpython-devguide--1532.org.readthedocs.build/

Previously we had scary red messages:
```
devguide/core-developers/memorialization.rst:5: WARNING: Duplicate explicit target name: "here". [docutils]
devguide/core-developers/memorialization.rst:5: WARNING: Duplicate explicit target name: "here". [docutils]
```
@nedbat nedbat requested a review from ambv March 18, 2025 12:23
@nedbat
Copy link
Member Author

nedbat commented Mar 18, 2025

Though TBH, that warning seems kind of dumb to me... Maybe we can disable it? /cc @hugovk

@hugovk
Copy link
Member

hugovk commented Mar 18, 2025

A double trailing underscore make the link an "anonymous" one and avoids warnings:

-`here <https://docs.github.com/en/site-policy/other-site-policies/github-deceased-user-policy>`_.
+`here <https://docs.github.com/en/site-policy/other-site-policies/github-deceased-user-policy>`__.

@nedbat
Copy link
Member Author

nedbat commented Mar 18, 2025

sigh there's always some other twist to learn about .rst.... I've used double-underscore in its other form:

Look over `there`__.

__ https://overthere.com

Copy link
Member

@ezio-melotti ezio-melotti left a comment

Choose a reason for hiding this comment

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

In general the text of the link shouldn't be a generic text like "here" or "link", but should reflect the content of the page it links to, so rephrasing those links would be preferred.

If possible, the link should be the actual title of the page and/or the name of the service (e.g. "See also the Discourse best practices for deceased community members"). Doing this will also avoid warnings.

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.

The general policy regarding deceased users on GitHub is described
`here <https://docs.github.com/en/site-policy/other-site-policies/github-deceased-user-policy>`_.
The general policy regarding deceased users on GitHub is described on their
`GitHub Deceased User Policy <https://docs.github.com/en/site-policy/other-site-policies/github-deceased-user-policy>`_
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
`GitHub Deceased User Policy <https://docs.github.com/en/site-policy/other-site-policies/github-deceased-user-policy>`_
`Deceased User Policy <https://docs.github.com/en/site-policy/other-site-policies/github-deceased-user-policy>`_

Comment on lines 44 to 45
The general policy regarding deceased users on GitHub is described on their
`GitHub Deceased User Policy <https://docs.github.com/en/site-policy/other-site-policies/github-deceased-user-policy>`_
Copy link
Member

Choose a reason for hiding this comment

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

Based on what we discussed, it would be better to include "GitHub" in the link, but the current sentence repeats it twice. I would either remove the other one:

Suggested change
The general policy regarding deceased users on GitHub is described on their
`GitHub Deceased User Policy <https://docs.github.com/en/site-policy/other-site-policies/github-deceased-user-policy>`_
The general policy regarding deceased users is described on their
`GitHub Deceased User Policy <https://docs.github.com/en/site-policy/other-site-policies/github-deceased-user-policy>`_ page.

or simply:

Suggested change
The general policy regarding deceased users on GitHub is described on their
`GitHub Deceased User Policy <https://docs.github.com/en/site-policy/other-site-policies/github-deceased-user-policy>`_
See also the `GitHub Deceased User Policy
<https://docs.github.com/en/site-policy/other-site-policies/github-deceased-user-policy>`_ page.

@nedbat
Copy link
Member Author

nedbat commented Mar 19, 2025

I've tweaked the GitHub link title to remove the duplication.

@nedbat nedbat merged commit f4df9cc into python:main Mar 19, 2025
4 checks passed
@nedbat nedbat deleted the nedbat/no-more-here branch March 19, 2025 12:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants