Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit 5072fcb

Browse filesBrowse files
lundibundiMylesBorins
lundibundi
authored and
MylesBorins
committed
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. 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>
1 parent 839f026 commit 5072fcb
Copy full SHA for 5072fcb
Expand file treeCollapse file tree

14 files changed

+20
-34
lines changed
Open diff view settings
Collapse file

‎doc/STYLE_GUIDE.md‎

Copy file name to clipboardExpand all lines: doc/STYLE_GUIDE.md
-4Lines changed: 0 additions & 4 deletions
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -51,10 +51,6 @@
5151
* References to constructor instances should use camelCase.
5252
* References to methods should be used with parentheses: for example,
5353
`socket.end()` instead of `socket.end`.
54-
* To draw special attention to a note, adhere to the following guidelines:
55-
* Make the "Note:" label italic, i.e. `*Note*:`.
56-
* Use a capital letter after the "Note:" label.
57-
* Preferably, make the note a new paragraph for better visual distinction.
5854
* Function arguments or object properties should use the following format:
5955
* ``` * `name` {type|type2} Optional description. **Default:** `value`. ```
6056
<!--lint disable maximum-line-length remark-lint-->
Collapse file

‎doc/api/assert.md‎

Copy file name to clipboardExpand all lines: doc/api/assert.md
+6-6Lines changed: 6 additions & 6 deletions
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -418,10 +418,10 @@ the function does not return a promise, `assert.doesNotReject()` will return a
418418
rejected `Promise` with an [`ERR_INVALID_RETURN_VALUE`][] error. In both cases
419419
the error handler is skipped.
420420

421-
Please note: Using `assert.doesNotReject()` is actually not useful because there
422-
is little benefit by catching a rejection and then rejecting it again. Instead,
423-
consider adding a comment next to the specific code path that should not reject
424-
and keep error messages as expressive as possible.
421+
Using `assert.doesNotReject()` is actually not useful because there is little
422+
benefit in catching a rejection and then rejecting it again. Instead, consider
423+
adding a comment next to the specific code path that should not reject and keep
424+
error messages as expressive as possible.
425425

426426
If specified, `error` can be a [`Class`][], [`RegExp`][] or a validation
427427
function. See [`assert.throws()`][] for more details.
@@ -464,8 +464,8 @@ changes:
464464

465465
Asserts that the function `fn` does not throw an error.
466466

467-
Please note: Using `assert.doesNotThrow()` is actually not useful because there
468-
is no benefit by catching an error and then rethrowing it. Instead, consider
467+
Using `assert.doesNotThrow()` is actually not useful because there
468+
is no benefit in catching an error and then rethrowing it. Instead, consider
469469
adding a comment next to the specific code path that should not throw and keep
470470
error messages as expressive as possible.
471471

Collapse file

‎doc/api/child_process.md‎

Copy file name to clipboardExpand all lines: doc/api/child_process.md
+2-2Lines changed: 2 additions & 2 deletions
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -1038,9 +1038,9 @@ child process may not actually terminate the process.
10381038

10391039
See kill(2) for reference.
10401040

1041-
Also note: on Linux, child processes of child processes will not be terminated
1041+
On Linux, child processes of child processes will not be terminated
10421042
when attempting to kill their parent. This is likely to happen when running a
1043-
new process in a shell or with use of the `shell` option of `ChildProcess`:
1043+
new process in a shell or with the use of the `shell` option of `ChildProcess`:
10441044

10451045
```js
10461046
'use strict';
Collapse file

‎doc/api/crypto.md‎

Copy file name to clipboardExpand all lines: doc/api/crypto.md
+1-1Lines changed: 1 addition & 1 deletion
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -848,7 +848,7 @@ const crypto = require('crypto');
848848
const alice = crypto.createECDH('secp256k1');
849849
const bob = crypto.createECDH('secp256k1');
850850

851-
// Note: This is a shortcut way to specify one of Alice's previous private
851+
// This is a shortcut way of specifying one of Alice's previous private
852852
// keys. It would be unwise to use such a predictable private key in a real
853853
// application.
854854
alice.setPrivateKey(
Collapse file

‎doc/api/dgram.md‎

Copy file name to clipboardExpand all lines: doc/api/dgram.md
+1-1Lines changed: 1 addition & 1 deletion
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -413,7 +413,7 @@ added: v8.6.0
413413

414414
* `multicastInterface` {string}
415415

416-
*Note: All references to scope in this section are referring to
416+
*All references to scope in this section are referring to
417417
[IPv6 Zone Indices][], which are defined by [RFC 4007][]. In string form, an IP
418418
with a scope index is written as `'IP%scope'` where scope is an interface name
419419
or interface number.*
Collapse file

‎doc/api/domain.md‎

Copy file name to clipboardExpand all lines: doc/api/domain.md
+1-1Lines changed: 1 addition & 1 deletion
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ if (cluster.isMaster) {
122122
d.on('error', (er) => {
123123
console.error(`error ${er.stack}`);
124124

125-
// Note: We're in dangerous territory!
125+
// We're in dangerous territory!
126126
// By definition, something unexpected occurred,
127127
// which we probably didn't want.
128128
// Anything can happen now! Be very careful!
Collapse file

‎doc/api/path.md‎

Copy file name to clipboardExpand all lines: doc/api/path.md
+1-1Lines changed: 1 addition & 1 deletion
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ path.posix.basename('/tmp/myfile.html');
5454
// Returns: 'myfile.html'
5555
```
5656

57-
*Note:* On Windows Node.js follows the concept of per-drive working directory.
57+
On Windows Node.js follows the concept of per-drive working directory.
5858
This behavior can be observed when using a drive path without a backslash. For
5959
example, `path.resolve('c:\\')` can potentially return a different result than
6060
`path.resolve('c:')`. For more information, see
Collapse file

‎doc/api/vm.md‎

Copy file name to clipboardExpand all lines: doc/api/vm.md
+1-1Lines changed: 1 addition & 1 deletion
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<!--name=vm-->
88

99
The `vm` module provides APIs for compiling and running code within V8 Virtual
10-
Machine contexts. **Note that the `vm` module is not a security mechanism. Do
10+
Machine contexts. **The `vm` module is not a security mechanism. Do
1111
not use it to run untrusted code**. The term "sandbox" is used throughout these
1212
docs simply to refer to a separate context, and does not confer any security
1313
guarantees.
Collapse file

‎doc/guides/backporting-to-release-lines.md‎

Copy file name to clipboardExpand all lines: doc/guides/backporting-to-release-lines.md
+1-1Lines changed: 1 addition & 1 deletion
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Each release line has a staging branch that the releaser will use as a scratch
66
pad while preparing a release. The branch name is formatted as follows:
77
`vN.x-staging` where `N` is the major release number.
88

9-
*Note*: For the active staging branches see the [Release Schedule][].
9+
For the active staging branches see the [Release Schedule][].
1010

1111
## What needs to be backported?
1212

Collapse file

‎doc/guides/maintaining-V8.md‎

Copy file name to clipboardExpand all lines: doc/guides/maintaining-V8.md
+1-1Lines changed: 1 addition & 1 deletion
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -228,7 +228,7 @@ to be cherry-picked in the Node.js repository and V8-CI must test the change.
228228
* Open a cherry-pick PR on `nodejs/node` targeting the *vY.x-staging* branch
229229
and notify the `@nodejs/v8` team.
230230
* Run the Node.js [V8 CI] in addition to the [Node.js CI].
231-
Note: The CI uses the `test-v8` target in the `Makefile`, which uses
231+
The CI uses the `test-v8` target in the `Makefile`, which uses
232232
`tools/make-v8.sh` to reconstruct a git tree in the `deps/v8` directory to
233233
run V8 tests.
234234

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.