Skip to content

doc: Harmonize YAML comments - #35454

Closed
aduh95 wants to merge 6 commits into
nodejs:masterfrom
aduh95:harmonize-yaml-comments
Closed

doc: Harmonize YAML comments#35454
aduh95 wants to merge 6 commits into
nodejs:masterfrom
aduh95:harmonize-yaml-comments

Conversation

@aduh95

@aduh95aduh95 commented Oct 1, 2020

Copy link
Copy Markdown
Contributor

Refs: nodejs/remark-preset-lint-node#139

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines

@nodejs-github-botnodejs-github-bot added the doc Issues and PRs related to the documentations. label Oct 1, 2020
@nodejs-github-bot

nodejs-github-bot commented Oct 1, 2020•
edited by aduh95
Loading

Copy link
Copy Markdown
Collaborator

Review requested:

  • @nodejs/http
  • @nodejs/http2
  • @nodejs/modules
  • @nodejs/n-api
  • @nodejs/net

@aduh95aduh95 mentioned this pull request Oct 1, 2020
Merged
3 tasks
@aduh95
aduh95force-pushed the harmonize-yaml-comments branch from 92a9141 to 6f007b4CompareOctober 2, 2020 09:55
@aduh95
aduh95 marked this pull request as ready for review October 2, 2020 09:55
@aduh95
aduh95 requested review from a team as code ownersOctober 2, 2020 09:55
@aduh95

aduh95 commented Oct 2, 2020

Copy link
Copy Markdown
ContributorAuthor

/cc @Trott@nschonni

Trott
Trott approved these changes Oct 2, 2020
View reviewed changes

@TrottTrott left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This just standardizes the ordering and spacing of things, right? Rubber-stamp LGTM if so.

aduh95
aduh95 commented Oct 2, 2020
View reviewed changes
Comment threaddoc/api/packages.md Outdated
nschonni
nschonni reviewed Oct 2, 2020
View reviewed changes

@nschonninschonni left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks a lot of work! Just left a comment below for a few other places I noticed the version number changing. Likely you just fixed it to match based on the PR landing and it they were just out of sync before

Comment threaddoc/api/dgram.md Outdated

@nschonninschonniOct 2, 2020

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Is the version supposed to change here?

@aduh95aduh95Oct 3, 2020

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

v0.10 is not a valid semver change, so I had to change it. According to GitHub UI, 332fea5 was part of v0.9.1 so I put that instead. I can make a separate PR for this if you think that's more appropriate.

@nschonninschonniOct 3, 2020

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I think it's fine, maybe just related to the old uneven releases being "unstable", so it wasn't officially documented till the next stable (even)

Comment threaddoc/api/deprecations.md Outdated
@aduh95
aduh95force-pushed the harmonize-yaml-comments branch from 6f007b4 to 4483f11CompareOctober 3, 2020 13:55
nschonni
nschonni reviewed Oct 3, 2020
View reviewed changes
Comment threaddoc/api/deprecations.md Outdated
@aduh95aduh95 mentioned this pull request Oct 4, 2020
Merged
@lpinca

lpinca commented Oct 5, 2020

Copy link
Copy Markdown
Member

@aduh95 can you please rebase?

@aduh95
aduh95force-pushed the harmonize-yaml-comments branch from 4483f11 to de4ee12CompareOctober 5, 2020 13:27
lpinca
lpinca approved these changes Oct 6, 2020
View reviewed changes

@lpincalpinca left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

RSLGTM

@lpincalpinca added the request-ci Add this label to start a Jenkins CI on a PR. label Oct 6, 2020
@github-actionsgithub-actionsBot removed the request-ci Add this label to start a Jenkins CI on a PR. label Oct 6, 2020
@nodejs-github-bot

nodejs-github-bot commented Oct 6, 2020

Copy link
Copy Markdown
Collaborator

CI: https://ci.nodejs.org/job/node-test-pull-request/33417/

ryzokuken
ryzokuken approved these changes Oct 6, 2020
View reviewed changes

@ryzokukenryzokuken left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

RSLGTM

@aduh95
aduh95force-pushed the harmonize-yaml-comments branch from de4ee12 to 51bde22CompareOctober 8, 2020 23:15
@aduh95aduh95 added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Oct 8, 2020
XadillaX
XadillaX approved these changes Oct 9, 2020
View reviewed changes

@XadillaXXadillaX left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

mhdawson
mhdawson approved these changes Oct 9, 2020
View reviewed changes

@mhdawsonmhdawson left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM

@aduh95aduh95 added the commit-queue Add this label to land a pull request using GitHub Actions. label Oct 9, 2020
@github-actionsgithub-actionsBot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Oct 9, 2020
@github-actions

github-actionsBot commented Oct 9, 2020

Copy link
Copy Markdown
Contributor

Landed in ce11b1c...bd45124

nodejs-github-bot pushed a commit that referenced this pull request Oct 9, 2020
@aduh95@nodejs-github-bot
doc: harmonize YAML comments style in deprecations.md
4cc0692
Refs: nodejs/remark-preset-lint-node#139
PR-URL: #35454
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ujjwal Sharma <ryzokuken@disroot.org>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Khaidi Chu <i@2333.moe>
Reviewed-By: Michael Dawson <midawson@redhat.com>
nodejs-github-bot pushed a commit that referenced this pull request Oct 9, 2020
@aduh95@nodejs-github-bot
doc: remove outstanding YAML comment
b3c3e01
Refs: nodejs/remark-preset-lint-node#139
PR-URL: #35454
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ujjwal Sharma <ryzokuken@disroot.org>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Khaidi Chu <i@2333.moe>
Reviewed-By: Michael Dawson <midawson@redhat.com>
nodejs-github-bot pushed a commit that referenced this pull request Oct 9, 2020
@aduh95@nodejs-github-bot
doc: fix missing PR-URLs in YAML comments
6eace77
Refs: nodejs/remark-preset-lint-node#139
PR-URL: #35454
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ujjwal Sharma <ryzokuken@disroot.org>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Khaidi Chu <i@2333.moe>
Reviewed-By: Michael Dawson <midawson@redhat.com>
nodejs-github-bot pushed a commit that referenced this pull request Oct 9, 2020
@aduh95@nodejs-github-bot
doc: harmonize version list style in YAML comments
125523b
Refs: nodejs/remark-preset-lint-node#139
PR-URL: #35454
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ujjwal Sharma <ryzokuken@disroot.org>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Khaidi Chu <i@2333.moe>
Reviewed-By: Michael Dawson <midawson@redhat.com>
nodejs-github-bot pushed a commit that referenced this pull request Oct 9, 2020
@aduh95@nodejs-github-bot
doc: changes description must end with a period
9fedb04
Refs: nodejs/remark-preset-lint-node#139
PR-URL: #35454
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ujjwal Sharma <ryzokuken@disroot.org>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Khaidi Chu <i@2333.moe>
Reviewed-By: Michael Dawson <midawson@redhat.com>
nodejs-github-bot pushed a commit that referenced this pull request Oct 9, 2020
@aduh95@nodejs-github-bot
doc: harmonize changes list ordering
bd45124
Refs: nodejs/remark-preset-lint-node#139
PR-URL: #35454
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ujjwal Sharma <ryzokuken@disroot.org>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Khaidi Chu <i@2333.moe>
Reviewed-By: Michael Dawson <midawson@redhat.com>
This was referenced Oct 9, 2020
Closed
Merged
BethGriggs pushed a commit that referenced this pull request Oct 14, 2020
@aduh95@BethGriggs
doc: harmonize YAML comments style in deprecations.md
a555246
Refs: nodejs/remark-preset-lint-node#139
PR-URL: #35454
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ujjwal Sharma <ryzokuken@disroot.org>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Khaidi Chu <i@2333.moe>
Reviewed-By: Michael Dawson <midawson@redhat.com>
BethGriggs pushed a commit that referenced this pull request Oct 14, 2020
@aduh95@BethGriggs
doc: remove outstanding YAML comment
02bf73e
Refs: nodejs/remark-preset-lint-node#139
PR-URL: #35454
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ujjwal Sharma <ryzokuken@disroot.org>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Khaidi Chu <i@2333.moe>
Reviewed-By: Michael Dawson <midawson@redhat.com>
BethGriggs pushed a commit that referenced this pull request Oct 14, 2020
@aduh95@BethGriggs
doc: fix missing PR-URLs in YAML comments
b3f15b7
Refs: nodejs/remark-preset-lint-node#139
PR-URL: #35454
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ujjwal Sharma <ryzokuken@disroot.org>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Khaidi Chu <i@2333.moe>
Reviewed-By: Michael Dawson <midawson@redhat.com>
BethGriggs pushed a commit that referenced this pull request Oct 14, 2020
@aduh95@BethGriggs
doc: harmonize version list style in YAML comments
28c94ca
Refs: nodejs/remark-preset-lint-node#139
PR-URL: #35454
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ujjwal Sharma <ryzokuken@disroot.org>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Khaidi Chu <i@2333.moe>
Reviewed-By: Michael Dawson <midawson@redhat.com>
MylesBorins pushed a commit that referenced this pull request Oct 14, 2020
@aduh95@MylesBorins
doc: changes description must end with a period
8cacca0
Refs: nodejs/remark-preset-lint-node#139
PR-URL: #35454
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ujjwal Sharma <ryzokuken@disroot.org>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Khaidi Chu <i@2333.moe>
Reviewed-By: Michael Dawson <midawson@redhat.com>
MylesBorins pushed a commit that referenced this pull request Oct 14, 2020
@aduh95@MylesBorins
doc: harmonize changes list ordering
62755b6
Refs: nodejs/remark-preset-lint-node#139
PR-URL: #35454
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ujjwal Sharma <ryzokuken@disroot.org>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Khaidi Chu <i@2333.moe>
Reviewed-By: Michael Dawson <midawson@redhat.com>
@MylesBorinsMylesBorins mentioned this pull request Oct 14, 2020
Merged
joesepi pushed a commit to joesepi/node that referenced this pull request Jan 8, 2021
@aduh95@joesepi
doc: harmonize YAML comments style in deprecations.md
fab879d
Refs: nodejs/remark-preset-lint-node#139
PR-URL: nodejs#35454
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ujjwal Sharma <ryzokuken@disroot.org>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Khaidi Chu <i@2333.moe>
Reviewed-By: Michael Dawson <midawson@redhat.com>
joesepi pushed a commit to joesepi/node that referenced this pull request Jan 8, 2021
@aduh95@joesepi
doc: remove outstanding YAML comment
85d67a9
Refs: nodejs/remark-preset-lint-node#139
PR-URL: nodejs#35454
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ujjwal Sharma <ryzokuken@disroot.org>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Khaidi Chu <i@2333.moe>
Reviewed-By: Michael Dawson <midawson@redhat.com>
joesepi pushed a commit to joesepi/node that referenced this pull request Jan 8, 2021
@aduh95@joesepi
doc: fix missing PR-URLs in YAML comments
0366cdb
Refs: nodejs/remark-preset-lint-node#139
PR-URL: nodejs#35454
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ujjwal Sharma <ryzokuken@disroot.org>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Khaidi Chu <i@2333.moe>
Reviewed-By: Michael Dawson <midawson@redhat.com>
joesepi pushed a commit to joesepi/node that referenced this pull request Jan 8, 2021
@aduh95@joesepi
doc: harmonize version list style in YAML comments
c8e9118
Refs: nodejs/remark-preset-lint-node#139
PR-URL: nodejs#35454
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ujjwal Sharma <ryzokuken@disroot.org>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Khaidi Chu <i@2333.moe>
Reviewed-By: Michael Dawson <midawson@redhat.com>
joesepi pushed a commit to joesepi/node that referenced this pull request Jan 8, 2021
@aduh95@joesepi
doc: changes description must end with a period
0c8e039
Refs: nodejs/remark-preset-lint-node#139
PR-URL: nodejs#35454
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ujjwal Sharma <ryzokuken@disroot.org>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Khaidi Chu <i@2333.moe>
Reviewed-By: Michael Dawson <midawson@redhat.com>
joesepi pushed a commit to joesepi/node that referenced this pull request Jan 8, 2021
@aduh95@joesepi
doc: harmonize changes list ordering
87535b1
Refs: nodejs/remark-preset-lint-node#139
PR-URL: nodejs#35454
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ujjwal Sharma <ryzokuken@disroot.org>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Khaidi Chu <i@2333.moe>
Reviewed-By: Michael Dawson <midawson@redhat.com>
targos pushed a commit that referenced this pull request May 1, 2021
@aduh95@targos
doc: harmonize changes list ordering
2e7f74c
Refs: nodejs/remark-preset-lint-node#139
PR-URL: #35454
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ujjwal Sharma <ryzokuken@disroot.org>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Khaidi Chu <i@2333.moe>
Reviewed-By: Michael Dawson <midawson@redhat.com>
@danielleadamsdanielleadams mentioned this pull request May 3, 2021
Merged
danielleadams pushed a commit that referenced this pull request May 8, 2021
@aduh95@danielleadams
doc: harmonize changes list ordering
b9cd835
Refs: nodejs/remark-preset-lint-node#139
PR-URL: #35454
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ujjwal Sharma <ryzokuken@disroot.org>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Khaidi Chu <i@2333.moe>
Reviewed-By: Michael Dawson <midawson@redhat.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@TrottTrottTrott approved these changes
@benjamingrbenjamingrbenjamingr approved these changes
@lpincalpincalpinca approved these changes
@trivikrtrivikrtrivikr approved these changes
+4 more reviewers
@nschonninschonninschonni approved these changes
@XadillaXXadillaXXadillaX approved these changes
@mhdawsonmhdawsonmhdawson approved these changes
@ryzokukenryzokukenryzokuken approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

author readyPRs that have at least one approval, no pending requests for changes, and a CI started.docIssues and PRs related to the documentations.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

10 participants

@aduh95@nodejs-github-bot@lpinca@Trott@nschonni@benjamingr@XadillaX@mhdawson@ryzokuken@trivikr