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.

Sign up for GitHub

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

Jump to bottom

doc: add blanks around code fences #29366

Closed
wants to merge 1 commit into from
Closed

doc: add blanks around code fences #29366

wants to merge 1 commit into from

Conversation

nschonni
Copy link
Member

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • tests and/or benchmarks are included
  • documentation is changed or added
  • commit message follows commit guidelines

@nschonni
doc: add blanks around code fences
70535d7 
Addresses Markdownlint MD031 rule warnings
@nodejs-github-bot nodejs-github-bot added build Issues and PRs related to build files or the CI. doc Issues and PRs related to the documentations. labels Aug 29, 2019
@trivikr
Copy link
Member

trivikr commented Aug 30, 2019

CI-lite: https://ci.nodejs.org/job/node-test-pull-request-lite-pipeline/3869/

@trivikr trivikr added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Aug 30, 2019
devsnek
devsnek approved these changes Aug 30, 2019
View reviewed changes
Copy link
Member

@devsnek devsnek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

does our markdown linter have a rule we could enable for this?

@nschonni
Copy link
Member Author

nschonni commented Aug 30, 2019 •
edited
Loading

The remark-lint equivalent is no-missing-blank-lines going by https://github.com/remarkjs/remark-lint/blob/master/doc/comparison-to-markdownlint.md, but I think it has some issues in that it doesn't ignore HTML comments and wants spaces for that too. It also requires the heading and lists spacing to be checked since it is one rule in that library

Edit: Markdownlint also flags the HTML comments trailing the headings

@Trott
Copy link
Member

Trott commented Aug 31, 2019

Landed in 9ab1e07

@Trott Trott closed this Aug 31, 2019
Trott pushed a commit that referenced this pull request Aug 31, 2019
@nschonni @Trott
doc: add blanks around code fences
9ab1e07 
Addresses Markdownlint MD031 rule warnings

PR-URL: #29366
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Jeremiah Senkpiel <[email protected]>
Reviewed-By: Trivikram Kamat <[email protected]>
Reviewed-By: Gus Caplan <[email protected]>
Reviewed-By: David Carlier <[email protected]>
@nschonni nschonni deleted the fix-md031 branch August 31, 2019 22:44
BridgeAR pushed a commit that referenced this pull request Sep 3, 2019
@nschonni @BridgeAR
doc: add blanks around code fences
4eedc4f 
Addresses Markdownlint MD031 rule warnings

PR-URL: #29366
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Jeremiah Senkpiel <[email protected]>
Reviewed-By: Trivikram Kamat <[email protected]>
Reviewed-By: Gus Caplan <[email protected]>
Reviewed-By: David Carlier <[email protected]>
@BridgeAR BridgeAR mentioned this pull request Sep 3, 2019
Merged
BridgeAR pushed a commit that referenced this pull request Sep 4, 2019
@nschonni @BridgeAR
doc: add blanks around code fences
3fc29b8 
Addresses Markdownlint MD031 rule warnings

PR-URL: #29366
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Jeremiah Senkpiel <[email protected]>
Reviewed-By: Trivikram Kamat <[email protected]>
Reviewed-By: Gus Caplan <[email protected]>
Reviewed-By: David Carlier <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@trivikr trivikr trivikr approved these changes

@devsnek devsnek devsnek approved these changes

@devnexen devnexen devnexen approved these changes

@Fishrock123 Fishrock123 Fishrock123 approved these changes

@Trott Trott Trott approved these changes

@jasnell jasnell jasnell approved these changes

Assignees
No one assigned
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. build Issues and PRs related to build files or the CI. doc Issues and PRs related to the documentations.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
8 participants
@nschonni @trivikr @Trott @jasnell @Fishrock123 @devnexen @devsnek @nodejs-github-bot