Skip to content

Commit 9c67262

Browse files
jasnelltargos
authored andcommitted
doc: remove **Note:** tags
Remove the various **Note:** prefixes throughout the docs. PR-URL: #18592 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Daniel Bevenius <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Michael Dawson <[email protected]>
1 parent 742b304 commit 9c67262

32 files changed

+491
-518
lines changed

doc/api/addons.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ specifically to compile Node.js Addons.
116116
}
117117
```
118118

119-
*Note*: A version of the `node-gyp` utility is bundled and distributed with
119+
A version of the `node-gyp` utility is bundled and distributed with
120120
Node.js as part of `npm`. This version is not made directly available for
121121
developers to use and is intended only to support the ability to use the
122122
`npm install` command to compile and install Addons. Developers who wish to

doc/api/async_hooks.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -306,8 +306,8 @@ property, set to `true` if the promise has a parent promise, and `false`
306306
otherwise. For example, in the case of `b = a.then(handler)`, `a` is considered
307307
a parent Promise of `b`. Here, `b` is considered a chained promise.
308308

309-
*Note*: In some cases the resource object is reused for performance reasons,
310-
it is thus not safe to use it as a key in a `WeakMap` or add properties to it.
309+
In some cases the resource object is reused for performance reasons, it is
310+
thus not safe to use it as a key in a `WeakMap` or add properties to it.
311311

312312
###### Asynchronous context example
313313

@@ -377,9 +377,9 @@ destroy: 9
377377
destroy: 5
378378
```
379379

380-
*Note*: As illustrated in the example, `executionAsyncId()` and `execution`
381-
each specify the value of the current execution context; which is delineated by
382-
calls to `before` and `after`.
380+
As illustrated in the example, `executionAsyncId()` and `execution` each specify
381+
the value of the current execution context; which is delineated by calls to
382+
`before` and `after`.
383383

384384
Only using `execution` to graph resource allocation results in the following:
385385

doc/api/buffer.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -192,10 +192,10 @@ The character encodings currently supported by Node.js include:
192192

193193
* `'hex'` - Encode each byte as two hexadecimal characters.
194194

195-
*Note*: Today's browsers follow the [WHATWG Encoding Standard][] which aliases
196-
both 'latin1' and ISO-8859-1 to win-1252. This means that while doing something
197-
like `http.get()`, if the returned charset is one of those listed in the WHATWG
198-
specification it is possible that the server actually returned
195+
Modern Web browsers follow the [WHATWG Encoding Standard][] which aliases
196+
both `'latin1'` and `'ISO-8859-1'` to `'win-1252'`. This means that while doing
197+
something like `http.get()`, if the returned charset is one of those listed in
198+
the WHATWG specification it is possible that the server actually returned
199199
win-1252-encoded data, and using `'latin1'` encoding may incorrectly decode the
200200
characters.
201201

@@ -681,9 +681,9 @@ Returns the actual byte length of a string. This is not the same as
681681
[`String.prototype.length`] since that returns the number of *characters* in
682682
a string.
683683

684-
*Note*: For `'base64'` and `'hex'`, this function assumes valid input. For
685-
strings that contain non-Base64/Hex-encoded data (e.g. whitespace), the return
686-
value might be greater than the length of a `Buffer` created from the string.
684+
For `'base64'` and `'hex'`, this function assumes valid input. For strings that
685+
contain non-Base64/Hex-encoded data (e.g. whitespace), the return value might be
686+
greater than the length of a `Buffer` created from the string.
687687

688688
Example:
689689

@@ -1815,8 +1815,8 @@ offset and cropped by the `start` and `end` indices.
18151815
Specifying `end` greater than [`buf.length`] will return the same result as
18161816
that of `end` equal to [`buf.length`].
18171817

1818-
*Note*: Modifying the new `Buffer` slice will modify the memory in the
1819-
original `Buffer` because the allocated memory of the two objects overlap.
1818+
Modifying the new `Buffer` slice will modify the memory in the original `Buffer`
1819+
because the allocated memory of the two objects overlap.
18201820

18211821
Example: Create a `Buffer` with the ASCII alphabet, take a slice, and then modify
18221822
one byte from the original `Buffer`

doc/api/child_process.md

+33-35
Original file line numberDiff line numberDiff line change
@@ -170,9 +170,8 @@ exec('echo "The \\$HOME variable is $HOME"');
170170
//The $HOME variable is escaped in the first instance, but not in the second
171171
```
172172

173-
*Note*: Never pass unsanitized user input to this function. Any input
174-
containing shell metacharacters may be used to trigger arbitrary command
175-
execution.
173+
**Never pass unsanitized user input to this function. Any input containing shell
174+
metacharacters may be used to trigger arbitrary command execution.**
176175

177176
```js
178177
const { exec } = require('child_process');
@@ -218,8 +217,8 @@ If `timeout` is greater than `0`, the parent will send the signal
218217
identified by the `killSignal` property (the default is `'SIGTERM'`) if the
219218
child runs longer than `timeout` milliseconds.
220219

221-
*Note*: Unlike the exec(3) POSIX system call, `child_process.exec()` does not
222-
replace the existing process and uses a shell to execute the command.
220+
Unlike the exec(3) POSIX system call, `child_process.exec()` does not replace
221+
the existing process and uses a shell to execute the command.
223222

224223
If this method is invoked as its [`util.promisify()`][]ed version, it returns
225224
a Promise for an object with `stdout` and `stderr` properties. In case of an
@@ -314,9 +313,9 @@ async function getVersion() {
314313
getVersion();
315314
```
316315

317-
*Note*: If the `shell` option is enabled, do not pass unsanitized user input
318-
to this function. Any input containing shell metacharacters may be used to
319-
trigger arbitrary command execution.
316+
**If the `shell` option is enabled, do not pass unsanitized user input to this
317+
function. Any input containing shell metacharacters may be used to trigger
318+
arbitrary command execution.**
320319

321320
### child_process.fork(modulePath[, args][, options])
322321
<!-- YAML
@@ -374,11 +373,11 @@ Node.js processes launched with a custom `execPath` will communicate with the
374373
parent process using the file descriptor (fd) identified using the
375374
environment variable `NODE_CHANNEL_FD` on the child process.
376375

377-
*Note*: Unlike the fork(2) POSIX system call, `child_process.fork()` does
378-
not clone the current process.
376+
Unlike the fork(2) POSIX system call, `child_process.fork()` does not clone the
377+
current process.
379378

380-
*Note*: The `shell` option available in [`child_process.spawn()`][] is not
381-
supported by `child_process.fork()` and will be ignored if set.
379+
The `shell` option available in [`child_process.spawn()`][] is not supported by
380+
`child_process.fork()` and will be ignored if set.
382381

383382
### child_process.spawn(command[, args][, options])
384383
<!-- YAML
@@ -424,9 +423,9 @@ The `child_process.spawn()` method spawns a new process using the given
424423
`command`, with command line arguments in `args`. If omitted, `args` defaults
425424
to an empty array.
426425

427-
*Note*: If the `shell` option is enabled, do not pass unsanitized user input to
428-
this function. Any input containing shell metacharacters may be used to
429-
trigger arbitrary command execution.
426+
**If the `shell` option is enabled, do not pass unsanitized user input to this
427+
function. Any input containing shell metacharacters may be used to trigger
428+
arbitrary command execution.**
430429

431430
A third argument may be used to specify additional options, with these defaults:
432431

@@ -513,12 +512,12 @@ subprocess.on('error', (err) => {
513512
});
514513
```
515514

516-
*Note*: Certain platforms (macOS, Linux) will use the value of `argv[0]` for
517-
the process title while others (Windows, SunOS) will use `command`.
515+
Certain platforms (macOS, Linux) will use the value of `argv[0]` for the process
516+
title while others (Windows, SunOS) will use `command`.
518517

519-
*Note*: Node.js currently overwrites `argv[0]` with `process.execPath` on
520-
startup, so `process.argv[0]` in a Node.js child process will not match the
521-
`argv0` parameter passed to `spawn` from the parent, retrieve it with the
518+
Node.js currently overwrites `argv[0]` with `process.execPath` on startup, so
519+
`process.argv[0]` in a Node.js child process will not match the `argv0`
520+
parameter passed to `spawn` from the parent, retrieve it with the
522521
`process.argv0` property instead.
523522

524523
#### options.detached
@@ -725,17 +724,17 @@ until the child process has fully closed. When a timeout has been encountered
725724
and `killSignal` is sent, the method won't return until the process has
726725
completely exited.
727726

728-
*Note*: If the child process intercepts and handles the `SIGTERM` signal and
727+
If the child process intercepts and handles the `SIGTERM` signal and
729728
does not exit, the parent process will still wait until the child process has
730729
exited.
731730

732731
If the process times out or has a non-zero exit code, this method ***will***
733732
throw an [`Error`][] that will include the full result of the underlying
734733
[`child_process.spawnSync()`][].
735734

736-
*Note*: If the `shell` option is enabled, do not pass unsanitized user input
737-
to this function. Any input containing shell metacharacters may be used to
738-
trigger arbitrary command execution.
735+
**If the `shell` option is enabled, do not pass unsanitized user input to this
736+
function. Any input containing shell metacharacters may be used to trigger
737+
arbitrary command execution.**
739738

740739
### child_process.execSync(command[, options])
741740
<!-- YAML
@@ -789,9 +788,8 @@ If the process times out or has a non-zero exit code, this method ***will***
789788
throw. The [`Error`][] object will contain the entire result from
790789
[`child_process.spawnSync()`][]
791790

792-
*Note*: Never pass unsanitized user input to this function. Any input
793-
containing shell metacharacters may be used to trigger arbitrary command
794-
execution.
791+
**Never pass unsanitized user input to this function. Any input containing shell
792+
metacharacters may be used to trigger arbitrary command execution.**
795793

796794
### child_process.spawnSync(command[, args][, options])
797795
<!-- YAML
@@ -857,9 +855,9 @@ completely exited. Note that if the process intercepts and handles the
857855
`SIGTERM` signal and doesn't exit, the parent process will wait until the child
858856
process has exited.
859857

860-
*Note*: If the `shell` option is enabled, do not pass unsanitized user input
861-
to this function. Any input containing shell metacharacters may be used to
862-
trigger arbitrary command execution.
858+
**If the `shell` option is enabled, do not pass unsanitized user input to this
859+
function. Any input containing shell metacharacters may be used to trigger
860+
arbitrary command execution.**
863861

864862
## Class: ChildProcess
865863
<!-- YAML
@@ -907,9 +905,9 @@ The `'error'` event is emitted whenever:
907905
2. The process could not be killed, or
908906
3. Sending a message to the child process failed.
909907

910-
*Note*: The `'exit'` event may or may not fire after an error has occurred.
911-
When listening to both the `'exit'` and `'error'` events, it is important
912-
to guard against accidentally invoking handler functions multiple times.
908+
The `'exit'` event may or may not fire after an error has occurred. When
909+
listening to both the `'exit'` and `'error'` events, it is important to guard
910+
against accidentally invoking handler functions multiple times.
913911

914912
See also [`subprocess.kill()`][] and [`subprocess.send()`][].
915913

@@ -948,7 +946,7 @@ added: v0.5.9
948946
The `'message'` event is triggered when a child process uses [`process.send()`][]
949947
to send messages.
950948

951-
*Note*: The message goes through serialization and parsing. The resulting
949+
The message goes through serialization and parsing. The resulting
952950
message might not be the same as what is originally sent.
953951

954952
### subprocess.channel
@@ -1111,7 +1109,7 @@ be used to send messages to the child process. When the child process is a
11111109
Node.js instance, these messages can be received via the
11121110
[`process.on('message')`][] event.
11131111

1114-
*Note*: The message goes through serialization and parsing. The resulting
1112+
The message goes through serialization and parsing. The resulting
11151113
message might not be the same as what is originally sent.
11161114

11171115
For example, in the parent script:

doc/api/cli.md

+20-20
Original file line numberDiff line numberDiff line change
@@ -53,9 +53,9 @@ changes:
5353
Evaluate the following argument as JavaScript. The modules which are
5454
predefined in the REPL can also be used in `script`.
5555

56-
*Note*: On Windows, using `cmd.exe` a single quote will not work correctly
57-
because it only recognizes double `"` for quoting. In Powershell or
58-
Git bash, both `'` and `"` are usable.
56+
On Windows, using `cmd.exe` a single quote will not work correctly because it
57+
only recognizes double `"` for quoting. In Powershell or Git bash, both `'`
58+
and `"` are usable.
5959

6060

6161
### `-p`, `--print "script"`
@@ -161,9 +161,9 @@ added: v8.0.0
161161

162162
Emit pending deprecation warnings.
163163

164-
*Note*: Pending deprecations are generally identical to a runtime deprecation
165-
with the notable exception that they are turned *off* by default and will not
166-
be emitted unless either the `--pending-deprecation` command line flag, or the
164+
Pending deprecations are generally identical to a runtime deprecation with the
165+
notable exception that they are turned *off* by default and will not be emitted
166+
unless either the `--pending-deprecation` command line flag, or the
167167
`NODE_PENDING_DEPRECATION=1` environment variable, is set. Pending deprecations
168168
are used to provide a kind of selective "early warning" mechanism that
169169
developers may leverage to detect deprecated API usage.
@@ -183,9 +183,9 @@ added: v0.10
183183
Aborting instead of exiting causes a core file to be generated for post-mortem
184184
analysis using a debugger (such as `lldb`, `gdb`, and `mdb`).
185185

186-
*Note*: If this flag is passed, the behavior can still be set to not abort
187-
through [`process.setUncaughtExceptionCaptureCallback()`][] (and through usage
188-
of the `domain` module that uses it).
186+
If this flag is passed, the behavior can still be set to not abort through
187+
[`process.setUncaughtExceptionCaptureCallback()`][] (and through usage of the
188+
`domain` module that uses it).
189189

190190
### `--trace-warnings`
191191
<!-- YAML
@@ -315,7 +315,7 @@ added: v0.1.3
315315

316316
Print V8 command line options.
317317

318-
*Note*: V8 options allow words to be separated by both dashes (`-`) or
318+
V8 options allow words to be separated by both dashes (`-`) or
319319
underscores (`_`).
320320

321321
For example, `--stack-trace-limit` is equivalent to `--stack_trace_limit`.
@@ -419,7 +419,7 @@ added: v0.1.32
419419

420420
`':'`-separated list of directories prefixed to the module search path.
421421

422-
*Note*: On Windows, this is a `';'`-separated list instead.
422+
On Windows, this is a `';'`-separated list instead.
423423

424424

425425
### `NODE_DISABLE_COLORS=1`
@@ -495,9 +495,9 @@ added: v8.0.0
495495

496496
When set to `1`, emit pending deprecation warnings.
497497

498-
*Note*: Pending deprecations are generally identical to a runtime deprecation
499-
with the notable exception that they are turned *off* by default and will not
500-
be emitted unless either the `--pending-deprecation` command line flag, or the
498+
Pending deprecations are generally identical to a runtime deprecation with the
499+
notable exception that they are turned *off* by default and will not be emitted
500+
unless either the `--pending-deprecation` command line flag, or the
501501
`NODE_PENDING_DEPRECATION=1` environment variable, is set. Pending deprecations
502502
are used to provide a kind of selective "early warning" mechanism that
503503
developers may leverage to detect deprecated API usage.
@@ -554,9 +554,9 @@ added: v7.7.0
554554
If `--use-openssl-ca` is enabled, this overrides and sets OpenSSL's directory
555555
containing trusted certificates.
556556

557-
*Note*: Be aware that unless the child environment is explicitly set, this
558-
environment variable will be inherited by any child processes, and if they use
559-
OpenSSL, it may cause them to trust the same CAs as node.
557+
Be aware that unless the child environment is explicitly set, this environment
558+
variable will be inherited by any child processes, and if they use OpenSSL, it
559+
may cause them to trust the same CAs as node.
560560

561561
### `SSL_CERT_FILE=file`
562562
<!-- YAML
@@ -566,9 +566,9 @@ added: v7.7.0
566566
If `--use-openssl-ca` is enabled, this overrides and sets OpenSSL's file
567567
containing trusted certificates.
568568

569-
*Note*: Be aware that unless the child environment is explicitly set, this
570-
environment variable will be inherited by any child processes, and if they use
571-
OpenSSL, it may cause them to trust the same CAs as node.
569+
Be aware that unless the child environment is explicitly set, this environment
570+
variable will be inherited by any child processes, and if they use OpenSSL, it
571+
may cause them to trust the same CAs as node.
572572

573573
### `NODE_REDIRECT_WARNINGS=file`
574574
<!-- YAML

doc/api/cluster.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -97,9 +97,9 @@ Node.js process and a cluster worker differs:
9797
port is random the first time, but predictable thereafter. To listen
9898
on a unique port, generate a port number based on the cluster worker ID.
9999

100-
*Note*: Node.js does not provide routing logic. It is, therefore important to
101-
design an application such that it does not rely too heavily on in-memory data
102-
objects for things like sessions and login.
100+
Node.js does not provide routing logic. It is, therefore important to design an
101+
application such that it does not rely too heavily on in-memory data objects for
102+
things like sessions and login.
103103

104104
Because workers are all separate processes, they can be killed or
105105
re-spawned depending on a program's needs, without affecting other

doc/api/console.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -122,8 +122,8 @@ console.assert(false, 'Whoops %s', 'didn\'t work');
122122
// AssertionError: Whoops didn't work
123123
```
124124

125-
*Note*: The `console.assert()` method is implemented differently in Node.js
126-
than the `console.assert()` method [available in browsers][web-api-assert].
125+
The `console.assert()` method is implemented differently in Node.js than the
126+
`console.assert()` method [available in browsers][web-api-assert].
127127

128128
Specifically, in browsers, calling `console.assert()` with a falsy
129129
assertion will cause the `message` to be printed to the console without
@@ -176,8 +176,8 @@ added: v8.3.0
176176
When `stdout` is a TTY, calling `console.clear()` will attempt to clear the
177177
TTY. When `stdout` is not a TTY, this method does nothing.
178178

179-
*Note*: The specific operation of `console.clear()` can vary across operating
180-
systems and terminal types. For most Linux operating systems, `console.clear()`
179+
The specific operation of `console.clear()` can vary across operating systems
180+
and terminal types. For most Linux operating systems, `console.clear()`
181181
operates similarly to the `clear` shell command. On Windows, `console.clear()`
182182
will clear only the output in the current terminal viewport for the Node.js
183183
binary.

0 commit comments

Comments
 (0)