Skip to content

Commit 99fffff

Browse files
lundibunditargos
authored andcommitted
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 8b5339d commit 99fffff

14 files changed

+20
-34
lines changed

doc/STYLE_GUIDE.md

-4
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-->

doc/api/assert.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -426,10 +426,10 @@ the function does not return a promise, `assert.doesNotReject()` will return a
426426
rejected `Promise` with an [`ERR_INVALID_RETURN_VALUE`][] error. In both cases
427427
the error handler is skipped.
428428

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

434434
If specified, `error` can be a [`Class`][], [`RegExp`][] or a validation
435435
function. See [`assert.throws()`][] for more details.
@@ -472,8 +472,8 @@ changes:
472472

473473
Asserts that the function `fn` does not throw an error.
474474

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

doc/api/child_process.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1056,9 +1056,9 @@ child process may not actually terminate the process.
10561056

10571057
See kill(2) for reference.
10581058

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

10631063
```js
10641064
'use strict';

doc/api/crypto.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -845,7 +845,7 @@ const crypto = require('crypto');
845845
const alice = crypto.createECDH('secp256k1');
846846
const bob = crypto.createECDH('secp256k1');
847847

848-
// Note: This is a shortcut way to specify one of Alice's previous private
848+
// This is a shortcut way of specifying one of Alice's previous private
849849
// keys. It would be unwise to use such a predictable private key in a real
850850
// application.
851851
alice.setPrivateKey(

doc/api/dgram.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -419,7 +419,7 @@ added: v8.6.0
419419

420420
* `multicastInterface` {string}
421421

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

doc/api/domain.md

+1-1
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!

doc/api/path.md

+1-1
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

doc/api/vm.md

+1-1
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.

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

+1-1
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

doc/guides/maintaining-V8.md

+1-1
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

doc/guides/maintaining-the-build-files.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ There are three main build files that may be directly run when building Node.js:
1111
- `configure`: A Python 2 script that detects system capabilities and runs
1212
[GYP][]. It generates `config.gypi` which includes parameters used by GYP to
1313
create platform-dependent build files. Its output is usually in one of these
14-
formats: Makefile, MSbuild, ninja, or XCode project files. (Note: the main
14+
formats: Makefile, MSbuild, ninja, or XCode project files (the main
1515
Makefile mentioned below is maintained separately by humans). For a detailed
1616
guide on this script, see [configure](#configure).
1717
- `vcbuild.bat`: A Windows Batch Script that locates build tools, provides a

doc/guides/using-internal-errors.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ in the ecosystem. For that reason, Node.js has considered error message changes
1414
to be breaking changes. By providing a permanent identifier for a specific
1515
error, we reduce the need for userland code to inspect error messages.
1616

17-
*Note*: Switching an existing error to use the `internal/errors` module must be
17+
Switching an existing error to use the `internal/errors` module must be
1818
considered a `semver-major` change.
1919

2020
## Using internal/errors.js

doc/node.1

-10
Original file line numberDiff line numberDiff line change
@@ -227,16 +227,6 @@ and
227227
.
228228
.It Fl -v8-options
229229
Print V8 command-line options.
230-
.Pp
231-
Note: V8 options allow words to be separated by both dashes
232-
.Sy ( - )
233-
or underscores
234-
.Sy ( _ ) .
235-
.Pp
236-
For example,
237-
.Fl -stack-trace-limit
238-
is equivalent to
239-
.Fl -stack_trace_limit .
240230
.
241231
.It Fl -v8-pool-size Ns = Ns Ar num
242232
Set V8's thread pool size which will be used to allocate background jobs.

doc/releases.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,7 @@ and also if there are non-trivial API changes. The rules are not yet strictly
182182
defined, so if in doubt, please confer with someone that will have a more
183183
informed perspective, such as a member of the NAN team.
184184

185-
*Note*: It is current TSC policy to bump major version when ABI changes. If you
185+
It is current TSC policy to bump major version when ABI changes. If you
186186
see a need to bump `NODE_MODULE_VERSION` then you should consult the TSC.
187187
Commits may need to be reverted or a major version bump may need to happen.
188188

@@ -263,7 +263,7 @@ doc/api/*.md`, and substitute this node version with `sed -i
263263
"s/REPLACEME/$VERSION/g" doc/api/*.md` or `perl -pi -e "s/REPLACEME/$VERSION/g"
264264
doc/api/*.md`.
265265

266-
*Note*: `$VERSION` should be prefixed with a `v`.
266+
`$VERSION` should be prefixed with a `v`.
267267

268268
If this release includes any new deprecations it is necessary to ensure that
269269
those are assigned a proper static deprecation code. These are listed in the
@@ -507,7 +507,7 @@ release, you should re-run `tools/release.sh` after the ARM builds have
507507
finished. That will move the ARM artifacts into the correct location. You will
508508
be prompted to re-sign SHASUMS256.txt.
509509

510-
*Note*: It is possible to only sign a release by running `./tools/release.sh -s
510+
It is possible to only sign a release by running `./tools/release.sh -s
511511
vX.Y.Z`.
512512

513513
### 14. Check the Release

0 commit comments

Comments
 (0)