perlfunc: Remove self-referential links #23263
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
It is misleading to link to the top of a section from within that section. This is like having a link to a home page from that home page; it doesn't do any good, and can cause you to lose your place in the middle of reading the section.
|
This sounds like a useful rule to add to a style guide |
tonycoz
approved these changes
May 7, 2025
Contributor
Author
|
@guest20, I'm finding myself resistant to putting this in a style guide. I think it should be self-evident that this isn't a good idea, and perhaps somewhat insulting to even bring it up. But I could be wrong. In this case, I did not do a git blame, but the links look to me that someone did a bulk programmatic update, and just didn't think about this possibility, so that this is unlikely to happen again. But I'd like to hear other opinions |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
It is misleading to link to the top of a section from within that section. This is like having a link to a home page from that home page; it doesn't do any good, and can cause you to lose your place in the middle of reading the section.