Unlink unintentional autolinked code ref links #254
Merged
Conversation
This file contains 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
RDoc can be overzealous when autolinking words that look like module
names. For example, autolinking every occurrence of "Rails" or "ERB".
This commit uses postprocessing to unlink autolinked code ref links that
appear to be unintentional. If a link's text is an uppercase letter
followed by either all lowercase letters (e.g. "Rails") or all uppercase
letters (e.g. "ERB"), then it's assumed the link is unintentional, and
the link is replaced with the just its text.
These kinds of modules can still be linked by prepending the module
namespace (e.g. "::ERB" or "ActionView::Template::Handlers::ERB"), or by
manually linking the text (e.g. "{Rails}[rdoc-ref:Rails]").
4 tasks
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.
RDoc can be overzealous when autolinking words that look like module names. For example, autolinking every occurrence of "Rails" or "ERB".
This commit uses postprocessing to unlink autolinked code ref links that appear to be unintentional. If a link's text is an uppercase letter followed by either all lowercase letters (e.g. "Rails") or all uppercase letters (e.g. "ERB"), then it's assumed the link is unintentional, and the link is replaced with the just its text.
These kinds of modules can still be linked by prepending the module namespace (e.g. "::ERB" or "ActionView::Template::Handlers::ERB"), or by manually linking the text (e.g. "{Rails}[rdoc-ref:Rails]").