[DOCS] Enable markdownlint rule MD031
#1331
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
|
I believe the git conflict can be easily addressed by pulling the latest changes from master and re-run pre-commit |
jbampton
force-pushed
the
docs-blanks-around-fences
branch
from
0fadc71
to
4266f2e
Compare
https://github.com/DavidAnson/markdownlint/blob/main/doc/md031.md "Rationale: Aside from aesthetic reasons, some parsers, including kramdown, will not parse fenced code blocks that don't have blank lines before and after them."
jbampton
force-pushed
the
docs-blanks-around-fences
branch
from
4266f2e
to
32d7bbe
Compare
jiayuasu
approved these changes
Apr 11, 2024
jiayuasu
pushed a commit
that referenced
this pull request
Apr 28, 2024
https://github.com/DavidAnson/markdownlint/blob/main/doc/md031.md "Rationale: Aside from aesthetic reasons, some parsers, including kramdown, will not parse fenced code blocks that don't have blank lines before and after them."
jiayuasu
added a commit
that referenced
this pull request
Apr 28, 2024
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.
https://github.com/DavidAnson/markdownlint/blob/main/doc/md031.md
"Rationale: Aside from aesthetic reasons, some parsers, including kramdown, will not parse fenced code blocks that don't have blank lines before and after them."
Did you read the Contributor Guide?
Is this PR related to a JIRA ticket?
[DOCS] my subject.What changes were proposed in this PR?
Standardized some Markdown files. We already use this format in many places in the docs.
Better to do it consistently in one format. And now we can test and enforce it.
How was this patch tested?
pre-commit run --all-filesDid this PR include necessary documentation updates?