Add a formatting step using mdformat as part of generate_mkdocs.py#10484
Merged
charliermarsh merged 4 commits intoastral-sh:mainfrom Mar 21, 2024
Merged
Add a formatting step using mdformat as part of generate_mkdocs.py#10484charliermarsh merged 4 commits intoastral-sh:mainfrom
mdformat as part of generate_mkdocs.py#10484charliermarsh merged 4 commits intoastral-sh:mainfrom
Conversation
zanieb
reviewed
Mar 20, 2024
zanieb
reviewed
Mar 20, 2024
b39eee1 to
be4da1a
Compare
be4da1a to
851e38a
Compare
Contributor
|
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.
Summary
The purpose of this change is mainly to address one of the issues outlined in #10427. Namely, some lists in the docs were not rendering properly when preceded by a text block without a newline character. This PR adds
mdformatas a final step to the rule documentation script, so that any missing newlines will be added.NB: The default behavior of
mdformatis to escape markdown special characters found in text such as<. This resulted in some misformatted docs. To address this I implemented an ad-hoc mdformat plugin to override the behavior. This may be considered a bit 'hacky', but I think it's a good solution. Nevertheless, if someone has a better idea, let me know.Test Plan
This change is hard to test systematically, however, I tried my best to look at the before and after diffs to ensure no unwanted changes were made to the docs.