Fix link refs used only inside MyST admonitions being dropped - #51
Open
BetterAndBetterII wants to merge 1 commit into
Open
Fix link refs used only inside MyST admonitions being dropped#51BetterAndBetterII wants to merge 1 commit into
BetterAndBetterII wants to merge 1 commit into
Conversation
MyST directives are tokenized as fences, so mdformat never saw reference-style links inside them and stripped the definitions. Record those labels as used while rendering directive fences. Fixes executablebooks#22
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
1 participant
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.
Summary
MyST directives are tokenized as fences, so reference-style links that only appear inside an admonition/directive body were treated as unused and their definitions were stripped. Record those labels as used while rendering directive fences (including nested directives). Unused defs outside directives are still removed.
Fixes #22
Test plan
pytest tests/test_mdformat_myst.py tests/test_commonmark_compliancy.py— 717 passed