Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork857
use page titles as link text to avoid warnings#1532
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Conversation
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]```
Though TBH, that warning seems kind of dumb to me... Maybe we can disable it? /cc@hugovk |
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>`__. |
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 |
There was a problem hiding this 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 theDiscourse best practices for deceased community members"). Doing this will also avoid warnings.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
core-developers/memorialization.rst Outdated
| 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>`_ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
| `GitHubDeceased 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>`_ |
core-developers/memorialization.rst Outdated
| 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>`_ |
There was a problem hiding this comment.
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:
| The general policy regarding deceased userson GitHubis 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:
| The general policy regarding deceased users onGitHubis described on their | |
| `GitHub Deceased User Policy<https://docs.github.com/en/site-policy/other-site-policies/github-deceased-user-policy>`_ | |
| See also the `GitHubDeceased User Policy | |
| <https://docs.github.com/en/site-policy/other-site-policies/github-deceased-user-policy>`_ page. |
I've tweaked the GitHub link title to remove the duplication. |
f4df9cc intopython:mainUh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
Previously we had scary red messages:
📚 Documentation preview 📚:https://cpython-devguide--1532.org.readthedocs.build/