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

doc: add blank line between comments #40160

Merged
merged 1 commit into from
Sep 22, 2021
Merged

doc: add blank line between comments #40160

merged 1 commit into from
Sep 22, 2021

Conversation

Trott
Copy link
Member

@Trott Trott commented Sep 20, 2021

Upcoming remark-based formatting/linting will add a blank line between
comments in markdown. This is in preparation for that change.

@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label Sep 20, 2021
Copy link
Contributor

@aduh95 aduh95 left a comment

Choose a reason for hiding this comment

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

Could we instead tweak remark settings to allow the both with and without blank lines? I have a slight preference for block of comments when they are related (comments to disable lint rules make more sense as one block than as three or more different blocks imho), but no strong feelings.

@Trott
Copy link
Member Author

Trott commented Sep 20, 2021

Could we instead tweak remark settings to allow the both with and without blank lines? I have a slight preference for block of comments when they are related (comments to disable lint rules make more sense as one block than as three or more different blocks imho), but no strong feelings.

My intention is to use it both as a linter and a formatter. If we use it as a formatter (like prettier), we have to choose one or the other. (Or at least I'd think so.)

However, in the case of lint comments, it's easy enough to consolidate them into a single comment, so that's what I'll do here.

@Trott Trott added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Sep 21, 2021
Upcoming remark-based formatting/linting will add a blank line between
comments in markdown. This is in preparation for that change.

PR-URL: nodejs#40160
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
@Trott
Copy link
Member Author

Trott commented Sep 22, 2021

Landed in 0991dfc

@Trott Trott merged commit 0991dfc into nodejs:master Sep 22, 2021
@Trott Trott deleted the md-blanks branch September 22, 2021 01:41
targos pushed a commit that referenced this pull request Oct 4, 2021
Upcoming remark-based formatting/linting will add a blank line between
comments in markdown. This is in preparation for that change.

PR-URL: #40160
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. doc Issues and PRs related to the documentations.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants