Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Enable markdownlint rule MD031 #1331

Merged
merged 1 commit into from
Apr 11, 2024

Conversation

jbampton
Copy link
Member

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?

  • No, this is a documentation update. The PR name follows the format [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-files

Did this PR include necessary documentation updates?

  • No, this PR does not affect any public API so no need to change the documentation.

@jiayuasu
Copy link
Member

I believe the git conflict can be easily addressed by pulling the latest changes from master and re-run pre-commit

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 jiayuasu merged commit ca0b075 into apache:master Apr 11, 2024
2 checks passed
@jbampton jbampton deleted the docs-blanks-around-fences branch April 12, 2024 09:07
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
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants