Resolve grammar rules in link reference definitions#2198
Merged
Conversation
Currently, in our Markdown, we support `[text][RULE_NAME]` and `[text][grammar-RULE_NAME]` for linking to grammar rules, but we don't support this syntax within link reference definitions, i.e., `[text]: grammar-RULE_NAME`, even though we do support linking to (non-grammar) rule identifiers within link reference definitions. That's an inconsistency that continually surprises us. Let's fix that. In this commit, we add `grammar_link_references`, which scans link reference definitions for destinations that match a grammar rule name -- either with a `grammar-` prefix or not. When a match is found, the destination is replaced with the resolved path and anchor, just as `rule_link_references` does for rules. Unrecognized destinations pass through unchanged, falling through to `std_links` for rustdoc resolution -- the same behavior as unresolved `[text][NAME]` reference links. We also update the dev-guide to document the new feature in both `links.md` and `grammar.md`.
rustbot
added
the
S-waiting-on-review
Draft
ehuss
approved these changes
Mar 4, 2026
rustbot
removed
the
S-waiting-on-review
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
Currently, in our Markdown, we support
[text][RULE_NAME]and[text][grammar-RULE_NAME]for linking to grammar rules, but we don't support this syntax within link reference definitions, i.e.,[text]: grammar-RULE_NAME, even though we do support linking to (non-grammar) rule identifiers within link reference definitions. That's an inconsistency that continually surprises us. Let's fix that.In this commit, we add
grammar_link_references, which scans link reference definitions for destinations that match a grammar rule name -- either with agrammar-prefix or not. When a match is found, the destination is replaced with the resolved path and anchor, just asrule_link_referencesdoes for rules. Unrecognized destinations pass through unchanged, falling through tostd_linksfor rustdoc resolution -- the same behavior as unresolved[text][NAME]reference links.We also update the dev-guide to document the new feature in both
links.mdandgrammar.md.cc @ehuss