Avoid linking file paths inside backticks #1495
Conversation
|
🚀 Preview deployment available at: https://2c9109b6.rdoc-6cd.pages.dev (commit: 3d94ce8) |
st0012
force-pushed
the
fix-incorrect-file-linking
branch
from
640c26c to
3d94ce8
Compare
| text | ||
| else | ||
| # Don't auto-link file paths in backticks | ||
| return "<code>#{CGI.escapeHTML text}</code>" |
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.
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?
There was a problem hiding this comment.
I think it's a good idea to disable it.
There was a problem hiding this comment.
For this pull request, we need to fix this.
See README.md `README.md`
Only filenames inside backtick should use `` but currently filenames outside backtick also converted to ``.
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.