doc: remove **Note:** tags - #18592
Closed
jasnell wants to merge 1 commit into
Closed
Conversation
Copy link
Copy Markdown
Member
Sorry, something went wrong.
Remove the various **Note:** prefixes throughout the docs.
Copy link
Copy Markdown
Member
|
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. |
Sorry, something went wrong.
Trott
approved these changes
Feb 6, 2018
danbev
approved these changes
Feb 6, 2018
cjihrig
approved these changes
Feb 6, 2018
BridgeAR
approved these changes
Feb 6, 2018
BridgeAR
left a comment
Copy link
Copy Markdown
Member
There was a problem hiding this comment.
I guess that is a good step towards only using it in really important cases.
Sorry, something went wrong.
devsnek
approved these changes
Feb 6, 2018
devsnek
left a comment
Copy link
Copy Markdown
Member
There was a problem hiding this comment.
Note: this is a good PR.
Sorry, something went wrong.
mhdawson
approved these changes
Feb 6, 2018
mhdawson
left a comment
Copy link
Copy Markdown
Member
There was a problem hiding this comment.
For consistency LGTM
Sorry, something went wrong.
Copy link
Copy Markdown
Member
Sorry, something went wrong.
Copy link
Copy Markdown
Contributor
|
Lite CI before landing: https://ci.nodejs.org/job/node-test-pull-request-lite/161/ |
Sorry, something went wrong.
apapirovski
pushed a commit
that referenced
this pull request
Feb 8, 2018
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>
Copy link
Copy Markdown
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. |
Sorry, something went wrong.
targos
pushed a commit
that referenced
this pull request
Mar 24, 2018
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>
MayaLekova
pushed a commit
to MayaLekova/node
that referenced
this pull request
May 8, 2018
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>
2 tasks
3 tasks
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 <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
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
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
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
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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Reviewers
11 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Remove the various Note: prefixes throughout the docs.
/cc @Trott
Checklist
Affected core subsystem(s)
doc