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: remove **Note:** tags #18592

Closed
wants to merge 1 commit into from
Closed

doc: remove **Note:** tags #18592

wants to merge 1 commit into from

Conversation

jasnell
Copy link
Member

@jasnell jasnell commented Feb 6, 2018

Remove the various Note: prefixes throughout the docs.

/cc @Trott

Checklist
Affected core subsystem(s)

doc

@jasnell
doc: remove **Note:** tags
0ba8ae2 
Remove the various **Note:** prefixes throughout the docs.
@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label Feb 6, 2018
@Trott
Copy link
Member

Trott commented Feb 6, 2018

Wait, what, you agree with me on this?! Whoa.

Totally LGTM. If this literally removes all the *Note*: occurrences, then there's also these four lines to remove from doc/STYLE_GUIDE.md:

* To draw special attention to a note, adhere to the following guidelines:
  * Make the "Note:" label italic, i.e. `*Note*:`.
  * Use a capital letter after the "Note:" label.
  * Preferably, make the note a new paragraph for better visual distinction.

BridgeAR
BridgeAR approved these changes Feb 6, 2018
View reviewed changes
Copy link
Member

@BridgeAR BridgeAR left a comment

Choose a reason for hiding this comment

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

I guess that is a good step towards only using it in really important cases.

devsnek
devsnek approved these changes Feb 6, 2018
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.

Note: this is a good PR.

mhdawson
mhdawson approved these changes Feb 6, 2018
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.

For consistency LGTM

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

BridgeAR commented Feb 6, 2018

Mini-CI https://ci.nodejs.org/job/node-test-commit-light/227/

@apapirovski
Copy link
Member

Lite CI before landing: https://ci.nodejs.org/job/node-test-pull-request-lite/161/

@apapirovski
Copy link
Member

Landed in d3569b6

@apapirovski apapirovski closed this Feb 8, 2018
apapirovski pushed a commit that referenced this pull request Feb 8, 2018
@jasnell @apapirovski
doc: remove **Note:** tags
d3569b6 
Remove the various **Note:** prefixes throughout the docs.

PR-URL: #18592
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
@MylesBorins
Copy link
Contributor

Should this be backported to v9.x-staging? If yes please follow the guide and raise a backport PR, if not let me know or add the dont-land-on label.

targos pushed a commit that referenced this pull request Mar 24, 2018
@jasnell @targos
doc: remove **Note:** tags
9c67262 
Remove the various **Note:** prefixes throughout the docs.

PR-URL: #18592
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
@targos targos removed the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Mar 24, 2018
@ChALkeR ChALkeR mentioned this pull request May 2, 2018
Closed
4 tasks
MayaLekova pushed a commit to MayaLekova/node that referenced this pull request May 8, 2018
@jasnell @MayaLekova
doc: remove **Note:** tags
1befbe4 
Remove the various **Note:** prefixes throughout the docs.

PR-URL: nodejs#18592
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
@ChALkeR ChALkeR mentioned this pull request Oct 24, 2018
Closed
2 tasks
@lundibundi lundibundi mentioned this pull request Oct 26, 2018
Closed
3 tasks
gdams pushed a commit that referenced this pull request Oct 29, 2018
@lundibundi
doc: remove notice of dashes in V8 options
f90cf19 
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 <riclau@uk.ibm.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: George Adams <george.adams@uk.ibm.com>
targos pushed a commit that referenced this pull request Nov 1, 2018
@lundibundi @targos
doc: remove notice of dashes in V8 options
99fffff 
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 <riclau@uk.ibm.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: George Adams <george.adams@uk.ibm.com>
MylesBorins pushed a commit that referenced this pull request Nov 26, 2018
@lundibundi @MylesBorins
doc: remove notice of dashes in V8 options
5072fcb 
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 <riclau@uk.ibm.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: George Adams <george.adams@uk.ibm.com>
rvagg pushed a commit that referenced this pull request Nov 28, 2018
@lundibundi @rvagg
doc: remove notice of dashes in V8 options
9094cb6 
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 <riclau@uk.ibm.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: George Adams <george.adams@uk.ibm.com>
MylesBorins pushed a commit that referenced this pull request Nov 29, 2018
@lundibundi @MylesBorins
doc: remove notice of dashes in V8 options
c8bf42a 
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 <riclau@uk.ibm.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: George Adams <george.adams@uk.ibm.com>
@sonicdoe sonicdoe mentioned this pull request Nov 16, 2020
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@danbev danbev danbev approved these changes

@Trott Trott Trott approved these changes

@cjihrig cjihrig cjihrig approved these changes

@devsnek devsnek devsnek approved these changes

@BridgeAR BridgeAR BridgeAR approved these changes

@mhdawson mhdawson mhdawson approved these changes

Assignees
No one assigned
Labels
doc Issues and PRs related to the documentations.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.