Avoid linking file paths inside backticks #1495
Open
+30
−3
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
Collaborator
|
🚀 Preview deployment available at: https://2c9109b6.rdoc-6cd.pages.dev (commit: 3d94ce8) |
tompng
reviewed
Dec 14, 2025
st0012
force-pushed
the
fix-incorrect-file-linking
branch
from
640c26c to
3d94ce8
Compare
tompng
reviewed
Dec 15, 2025
| text | ||
| else | ||
| # Don't auto-link file paths in backticks | ||
| return "<code>#{CGI.escapeHTML text}</code>" |
Member
There was a problem hiding this comment.
If the README.md content is
README `README`Two "README" will both trigger link("README", "README", true, false).
One from handle_regexp_CROSSREF → cross_reference → link
Another from convert_tt_crossref → cross_reference → link
So if we need to detect backticks, we need to pass a new argument from convert_tt_crossref.
Member
Author
There was a problem hiding this comment.
I'm surprised that README without backticks would also enter here. But I guess it's the same mechanism linking String or Array automatically.
I kinda want to disable this in a breaking change release, perhaps in v8.0. WDYT?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Highlighting file paths like
lib/foo/bar.rbshould not be linked to the file automatically. If the writer's intention is to link it,rdoc-refshould be used.