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: finish cleaning up *Note* tags #23903

Closed
wants to merge 3 commits into from

Conversation

lundibundi
Copy link
Member

@lundibundi lundibundi commented Oct 26, 2018

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

Refs: #18592

Edit: added second commit clearing Man page
doc: remove notice of dashes in V8 options

Previously only V8 options supported both dashes in them (making them
equivalent), but now Node.js also supports both styles so the note can
be removed.

@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label Oct 26, 2018
@vsemozhetbyt
Copy link
Contributor

It seems we have some more cases with *Note:* / Please note: / Also note: / just Note: variants.

@lundibundi
Copy link
Member Author

@vsemozhetbyt yeah, but those are harder to remove than plain Note as IMO those usually require additional changes to persist the intent of a message.

I've cleaned up a few more of them, though there is still a few left.

@vsemozhetbyt vsemozhetbyt added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Oct 26, 2018
@vsemozhetbyt
Copy link
Contributor

Previously only V8 options supported both dashes in them (making them
equivalent), but now Node.js also supports both styles so the note can
be removed.

Refs: nodejs#23020
@lundibundi
Copy link
Member Author

lundibundi commented Oct 26, 2018

@vsemozhetbyt I've made a few more changes, so this should wait for a bit more as those reviews only account for a part of the changes.

Removed 'author ready' to make sure this doesn't land without the reviews of the recent changes.

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

@lundibundi lundibundi removed the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Oct 26, 2018
is little benefit by catching a rejection and then rejecting it again. Instead,
consider adding a comment next to the specific code path that should not reject
and keep error messages as expressive as possible.
Using `assert.doesNotReject()` is actually not useful because there is a little
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Using `assert.doesNotReject()` is actually not useful because there is a little
Using `assert.doesNotReject()` is actually not useful because there is little

@Trott
Copy link
Member

Trott commented Oct 27, 2018

@lundibundi lundibundi added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Oct 29, 2018
@gdams
Copy link
Member

gdams commented Oct 29, 2018

landed in: f90cf19

@gdams gdams closed this Oct 29, 2018
gdams pushed a commit that referenced this pull request Oct 29, 2018
Previously only V8 options supported both dashes in them (making them
equivalent), but now Node.js also supports both styles so the note can
be removed.

PR-URL: #23903
Refs: #18592
Reviewed-By: Richard Lau <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Vse Mozhet Byt <[email protected]>
Reviewed-By: Trivikram Kamat <[email protected]>
Reviewed-By: George Adams <[email protected]>
targos pushed a commit that referenced this pull request Nov 1, 2018
Previously only V8 options supported both dashes in them (making them
equivalent), but now Node.js also supports both styles so the note can
be removed.

PR-URL: #23903
Refs: #18592
Reviewed-By: Richard Lau <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Vse Mozhet Byt <[email protected]>
Reviewed-By: Trivikram Kamat <[email protected]>
Reviewed-By: George Adams <[email protected]>
MylesBorins pushed a commit that referenced this pull request Nov 26, 2018
Previously only V8 options supported both dashes in them (making them
equivalent), but now Node.js also supports both styles so the note can
be removed.

PR-URL: #23903
Refs: #18592
Reviewed-By: Richard Lau <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Vse Mozhet Byt <[email protected]>
Reviewed-By: Trivikram Kamat <[email protected]>
Reviewed-By: George Adams <[email protected]>
@codebytere codebytere mentioned this pull request Nov 27, 2018
rvagg pushed a commit that referenced this pull request Nov 28, 2018
Previously only V8 options supported both dashes in them (making them
equivalent), but now Node.js also supports both styles so the note can
be removed.

PR-URL: #23903
Refs: #18592
Reviewed-By: Richard Lau <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Vse Mozhet Byt <[email protected]>
Reviewed-By: Trivikram Kamat <[email protected]>
Reviewed-By: George Adams <[email protected]>
MylesBorins pushed a commit that referenced this pull request Nov 29, 2018
Previously only V8 options supported both dashes in them (making them
equivalent), but now Node.js also supports both styles so the note can
be removed.

PR-URL: #23903
Refs: #18592
Reviewed-By: Richard Lau <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Vse Mozhet Byt <[email protected]>
Reviewed-By: Trivikram Kamat <[email protected]>
Reviewed-By: George Adams <[email protected]>
@codebytere codebytere mentioned this pull request Nov 29, 2018
@vsemozhetbyt vsemozhetbyt mentioned this pull request Mar 12, 2019
4 tasks
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.

9 participants