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: fix comma splice #40133

Closed
wants to merge 2 commits into from
Closed

doc: fix comma splice #40133

wants to merge 2 commits into from

Conversation

Trott
Copy link
Member

@Trott Trott commented Sep 17, 2021

No description provided.

@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. http Issues or PRs related to the http subsystem. labels Sep 17, 2021
aduh95
aduh95 reviewed Sep 17, 2021
View reviewed changes
doc/api/http.md Outdated
@@ -2498,7 +2498,7 @@ added: v0.9.12

* `msesc` {number}
* `callback` {Function} Optional function to be called when a timeout
occurs, Same as binding to the `timeout` event.
occurs. Same as binding to the `timeout` event.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
occurs. Same as binding to the `timeout` event.
occurs. Same as binding to the `timeout` event.

Copy link
Member Author

@Trott Trott Sep 17, 2021 •
edited
Loading

Choose a reason for hiding this comment

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

Thanks. I'll look into adding https://github.com/freeletics/remark-lint-blank-lines something to lint for these kinds of things. I also wonder if I need to review #40042 a little closer.

Copy link
Member Author

Choose a reason for hiding this comment

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

Actually, seems like I was right the first time. Making the suggested change but not concerned about #40042 as much.

Copy link
Member Author

Choose a reason for hiding this comment

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

It looks like using remark to format the markdown (similar to using prettier for JS code) would have corrected this. I wonder if we should do that for all the files, and then have either a Makefile task or a GitHub Action to keep things that way.

Copy link
Contributor

Choose a reason for hiding this comment

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

(FWIW prettier also works for markdown documents, it's not limited to JS code.)

Aren't we using remark already? That's what the name of the repo suggests: nodejs/remark-preset-lint-node.

Copy link
Member Author

Choose a reason for hiding this comment

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

We use remark to lint but not to format. I'm in the midst of changing that.

@Trott Trott mentioned this pull request Sep 17, 2021
Closed
mhdawson
mhdawson approved these changes Sep 17, 2021
View reviewed changes
Copy link
Member

@mhdawson mhdawson left a comment

Choose a reason for hiding this comment

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

LGTM

@Trott Trott added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Sep 18, 2021
@targos targos added the commit-queue Add this label to land a pull request using GitHub Actions. label Sep 19, 2021
@github-actions github-actions bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Sep 19, 2021
@github-actions
Copy link
Contributor

Landed in 088c01b...0bafe6d

@github-actions github-actions bot closed this Sep 19, 2021
nodejs-github-bot pushed a commit that referenced this pull request Sep 19, 2021
@Trott @nodejs-github-bot
doc: fix comma splice
0bafe6d 
PR-URL: #40133
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
BethGriggs pushed a commit that referenced this pull request Sep 21, 2021
@Trott @BethGriggs
doc: fix comma splice
0649e88 
PR-URL: #40133
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
BethGriggs pushed a commit that referenced this pull request Sep 21, 2021
@Trott @BethGriggs
doc: fix comma splice
a07d844 
PR-URL: #40133
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
@BethGriggs BethGriggs mentioned this pull request Sep 21, 2021
Merged
1 task
@Trott Trott deleted the comma-splice branch September 25, 2022 17:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@aduh95 aduh95 aduh95 approved these changes

@mhdawson mhdawson mhdawson approved these changes

@tniessen tniessen tniessen approved these changes

@cjihrig cjihrig cjihrig approved these changes

@lpinca lpinca lpinca approved these changes

@addaleax addaleax addaleax 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. doc Issues and PRs related to the documentations. http Issues or PRs related to the http subsystem.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
9 participants
@Trott @addaleax @lpinca @cjihrig @tniessen @mhdawson @aduh95 @targos @nodejs-github-bot