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

Author: jasnell

doc/api/addons.md

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

doc/api/async_hooks.md

@@ -306,8 +306,8 @@ set to the `asyncId` of a parent Promise, if there is one, and `undefined`
 otherwise. For example, in the case of `b = a.then(handler)`, `a` is considered
 a parent Promise of `b`.
 
-*Note*: In some cases the resource object is reused for performance reasons,
-it is thus not safe to use it as a key in a `WeakMap` or add properties to it.
+In some cases the resource object is reused for performance reasons, it is
+thus not safe to use it as a key in a `WeakMap` or add properties to it.
 
 ###### Asynchronous context example
 
@@ -377,9 +377,9 @@ destroy: 9
 destroy: 5
 ```
 
-*Note*: As illustrated in the example, `executionAsyncId()` and `execution`
-each specify the value of the current execution context; which is delineated by
-calls to `before` and `after`.
+As illustrated in the example, `executionAsyncId()` and `execution` each specify
+the value of the current execution context; which is delineated by calls to
+`before` and `after`.
 
 Only using `execution` to graph resource allocation results in the following:
 
@@ -599,7 +599,7 @@ own resources.
 
 The `init` hook will trigger when an `AsyncResource` is instantiated.
 
-*Note*: `before` and `after` calls must be unwound in the same order that they
+The `before` and `after` calls must be unwound in the same order that they
 are called. Otherwise, an unrecoverable exception will occur and the process
 will abort.
 

doc/api/buffer.md

@@ -195,10 +195,10 @@ The character encodings currently supported by Node.js include:
 
 * `'hex'` - Encode each byte as two hexadecimal characters.
 
-*Note*: Today's browsers follow the [WHATWG Encoding Standard][] which aliases
-both 'latin1' and ISO-8859-1 to win-1252. This means that while doing something
-like `http.get()`, if the returned charset is one of those listed in the WHATWG
-specification it is possible that the server actually returned
+Modern Web browsers follow the [WHATWG Encoding Standard][] which aliases
+both `'latin1'` and `'ISO-8859-1'` to `'win-1252'`. This means that while doing
+something like `http.get()`, if the returned charset is one of those listed in
+the WHATWG specification it is possible that the server actually returned
 win-1252-encoded data, and using `'latin1'` encoding may incorrectly decode the
 characters.
 
@@ -702,9 +702,9 @@ Returns the actual byte length of a string. This is not the same as
 [`String.prototype.length`] since that returns the number of *characters* in
 a string.
 
-*Note*: For `'base64'` and `'hex'`, this function assumes valid input. For
-strings that contain non-Base64/Hex-encoded data (e.g. whitespace), the return
-value might be greater than the length of a `Buffer` created from the string.
+For `'base64'` and `'hex'`, this function assumes valid input. For strings that
+contain non-Base64/Hex-encoded data (e.g. whitespace), the return value might be
+greater than the length of a `Buffer` created from the string.
 
 Example:
 
@@ -1948,8 +1948,8 @@ offset and cropped by the `start` and `end` indices.
 Specifying `end` greater than [`buf.length`] will return the same result as
 that of `end` equal to [`buf.length`].
 
-*Note*: Modifying the new `Buffer` slice will modify the memory in the
-original `Buffer` because the allocated memory of the two objects overlap.
+Modifying the new `Buffer` slice will modify the memory in the original `Buffer`
+because the allocated memory of the two objects overlap.
 
 Example: Create a `Buffer` with the ASCII alphabet, take a slice, and then modify
 one byte from the original `Buffer`

doc/api/child_process.md

@@ -170,9 +170,8 @@ exec('echo "The \\$HOME variable is $HOME"');
 //The $HOME variable is escaped in the first instance, but not in the second
 ```
 
-*Note*: Never pass unsanitized user input to this function. Any input
-containing shell metacharacters may be used to trigger arbitrary command
-execution.
+**Never pass unsanitized user input to this function. Any input containing shell
+metacharacters may be used to trigger arbitrary command execution.**
 
 ```js
 const { exec } = require('child_process');
@@ -218,8 +217,8 @@ If `timeout` is greater than `0`, the parent will send the signal
 identified by the `killSignal` property (the default is `'SIGTERM'`) if the
 child runs longer than `timeout` milliseconds.
 
-*Note*: Unlike the exec(3) POSIX system call, `child_process.exec()` does not
-replace the existing process and uses a shell to execute the command.
+Unlike the exec(3) POSIX system call, `child_process.exec()` does not replace
+the existing process and uses a shell to execute the command.
 
 If this method is invoked as its [`util.promisify()`][]ed version, it returns
 a Promise for an object with `stdout` and `stderr` properties. In case of an
@@ -316,9 +315,9 @@ async function getVersion() {
 getVersion();
 ```
 
-*Note*: If the `shell` option is enabled, do not pass unsanitized user input
-to this function. Any input containing shell metacharacters may be used to
-trigger arbitrary command execution.
+**If the `shell` option is enabled, do not pass unsanitized user input to this
+function. Any input containing shell metacharacters may be used to trigger
+arbitrary command execution.**
 
 ### child_process.fork(modulePath[, args][, options])
 <!-- YAML
@@ -376,11 +375,11 @@ Node.js processes launched with a custom `execPath` will communicate with the
 parent process using the file descriptor (fd) identified using the
 environment variable `NODE_CHANNEL_FD` on the child process.
 
-*Note*: Unlike the fork(2) POSIX system call, `child_process.fork()` does
-not clone the current process.
+Unlike the fork(2) POSIX system call, `child_process.fork()` does not clone the
+current process.
 
-*Note*: The `shell` option available in [`child_process.spawn()`][] is not
-supported by `child_process.fork()` and will be ignored if set.
+The `shell` option available in [`child_process.spawn()`][] is not supported by
+`child_process.fork()` and will be ignored if set.
 
 ### child_process.spawn(command[, args][, options])
 <!-- YAML
@@ -426,9 +425,9 @@ The `child_process.spawn()` method spawns a new process using the given
 `command`, with command line arguments in `args`. If omitted, `args` defaults
 to an empty array.
 
-*Note*: If the `shell` option is enabled, do not pass unsanitized user input to
-this function. Any input containing shell metacharacters may be used to
-trigger arbitrary command execution.
+**If the `shell` option is enabled, do not pass unsanitized user input to this
+function. Any input containing shell metacharacters may be used to trigger
+arbitrary command execution.**
 
 A third argument may be used to specify additional options, with these defaults:
 
@@ -517,12 +516,12 @@ subprocess.on('error', (err) => {
 });
 ```
 
-*Note*: Certain platforms (macOS, Linux) will use the value of `argv[0]` for
-the process title while others (Windows, SunOS) will use `command`.
+Certain platforms (macOS, Linux) will use the value of `argv[0]` for the process
+title while others (Windows, SunOS) will use `command`.
 
-*Note*: Node.js currently overwrites `argv[0]` with `process.execPath` on
-startup, so `process.argv[0]` in a Node.js child process will not match the
-`argv0` parameter passed to `spawn` from the parent, retrieve it with the
+Node.js currently overwrites `argv[0]` with `process.execPath` on startup, so
+`process.argv[0]` in a Node.js child process will not match the `argv0`
+parameter passed to `spawn` from the parent, retrieve it with the
 `process.argv0` property instead.
 
 #### options.detached
@@ -725,17 +724,17 @@ until the child process has fully closed. When a timeout has been encountered
 and `killSignal` is sent, the method won't return until the process has
 completely exited.
 
-*Note*: If the child process intercepts and handles the `SIGTERM` signal and
+If the child process intercepts and handles the `SIGTERM` signal and
 does not exit, the parent process will still wait until the child process has
 exited.
 
 If the process times out or has a non-zero exit code, this method ***will***
 throw an [`Error`][] that will include the full result of the underlying
 [`child_process.spawnSync()`][].
 
-*Note*: If the `shell` option is enabled, do not pass unsanitized user input
-to this function. Any input containing shell metacharacters may be used to
-trigger arbitrary command execution.
+**If the `shell` option is enabled, do not pass unsanitized user input to this
+function. Any input containing shell metacharacters may be used to trigger
+arbitrary command execution.**
 
 ### child_process.execSync(command[, options])
 <!-- YAML
@@ -789,9 +788,8 @@ If the process times out or has a non-zero exit code, this method ***will***
 throw.  The [`Error`][] object will contain the entire result from
 [`child_process.spawnSync()`][]
 
-*Note*: Never pass unsanitized user input to this function. Any input
-containing shell metacharacters may be used to trigger arbitrary command
-execution.
+**Never pass unsanitized user input to this function. Any input containing shell
+metacharacters may be used to trigger arbitrary command execution.**
 
 ### child_process.spawnSync(command[, args][, options])
 <!-- YAML
@@ -857,9 +855,9 @@ completely exited. Note that if the process intercepts and handles the
 `SIGTERM` signal and doesn't exit, the parent process will wait until the child
 process has exited.
 
-*Note*: If the `shell` option is enabled, do not pass unsanitized user input
-to this function. Any input containing shell metacharacters may be used to
-trigger arbitrary command execution.
+**If the `shell` option is enabled, do not pass unsanitized user input to this
+function. Any input containing shell metacharacters may be used to trigger
+arbitrary command execution.**
 
 ## Class: ChildProcess
 <!-- YAML
@@ -907,9 +905,9 @@ The `'error'` event is emitted whenever:
 2. The process could not be killed, or
 3. Sending a message to the child process failed.
 
-*Note*: The `'exit'` event may or may not fire after an error has occurred.
-When listening to both the `'exit'` and `'error'` events, it is important
-to guard against accidentally invoking handler functions multiple times.
+The `'exit'` event may or may not fire after an error has occurred. When
+listening to both the `'exit'` and `'error'` events, it is important to guard
+against accidentally invoking handler functions multiple times.
 
 See also [`subprocess.kill()`][] and [`subprocess.send()`][].
 
@@ -948,7 +946,7 @@ added: v0.5.9
 The `'message'` event is triggered when a child process uses [`process.send()`][]
 to send messages.
 
-*Note*: The message goes through serialization and parsing. The resulting
+The message goes through serialization and parsing. The resulting
 message might not be the same as what is originally sent.
 
 ### subprocess.channel
@@ -1111,7 +1109,7 @@ be used to send messages to the child process. When the child process is a
 Node.js instance, these messages can be received via the
 [`process.on('message')`][] event.
 
-*Note*: The message goes through serialization and parsing. The resulting
+The message goes through serialization and parsing. The resulting
 message might not be the same as what is originally sent.
 
 For example, in the parent script:

doc/api/cli.md

@@ -53,9 +53,9 @@ changes:
 Evaluate the following argument as JavaScript. The modules which are
 predefined in the REPL can also be used in `script`.
 
-*Note*: On Windows, using `cmd.exe` a single quote will not work correctly
-because it only recognizes double `"` for quoting. In Powershell or
-Git bash, both `'` and `"` are usable.
+On Windows, using `cmd.exe` a single quote will not work correctly because it
+only recognizes double `"` for quoting. In Powershell or Git bash, both `'`
+and `"` are usable.
 
 
 ### `-p`, `--print "script"`
@@ -161,9 +161,9 @@ added: v8.0.0
 
 Emit pending deprecation warnings.
 
-*Note*: Pending deprecations are generally identical to a runtime deprecation
-with the notable exception that they are turned *off* by default and will not
-be emitted unless either the `--pending-deprecation` command line flag, or the
+Pending deprecations are generally identical to a runtime deprecation with the
+notable exception that they are turned *off* by default and will not be emitted
+unless either the `--pending-deprecation` command line flag, or the
 `NODE_PENDING_DEPRECATION=1` environment variable, is set. Pending deprecations
 are used to provide a kind of selective "early warning" mechanism that
 developers may leverage to detect deprecated API usage.
@@ -183,9 +183,9 @@ added: v0.10
 Aborting instead of exiting causes a core file to be generated for post-mortem
 analysis using a debugger (such as `lldb`, `gdb`, and `mdb`).
 
-*Note*: If this flag is passed, the behavior can still be set to not abort
-through [`process.setUncaughtExceptionCaptureCallback()`][] (and through usage
-of the `domain` module that uses it).
+If this flag is passed, the behavior can still be set to not abort through
+[`process.setUncaughtExceptionCaptureCallback()`][] (and through usage of the
+`domain` module that uses it).
 
 ### `--trace-warnings`
 <!-- YAML
@@ -307,7 +307,7 @@ added: v0.1.3
 
 Print V8 command line options.
 
-*Note*: V8 options allow words to be separated by both dashes (`-`) or
+V8 options allow words to be separated by both dashes (`-`) or
 underscores (`_`).
 
 For example, `--stack-trace-limit` is equivalent to `--stack_trace_limit`.
@@ -411,7 +411,7 @@ added: v0.1.32
 
 `':'`-separated list of directories prefixed to the module search path.
 
-*Note*: On Windows, this is a `';'`-separated list instead.
+On Windows, this is a `';'`-separated list instead.
 
 
 ### `NODE_DISABLE_COLORS=1`
@@ -486,9 +486,9 @@ added: v8.0.0
 
 When set to `1`, emit pending deprecation warnings.
 
-*Note*: Pending deprecations are generally identical to a runtime deprecation
-with the notable exception that they are turned *off* by default and will not
-be emitted unless either the `--pending-deprecation` command line flag, or the
+Pending deprecations are generally identical to a runtime deprecation with the
+notable exception that they are turned *off* by default and will not be emitted
+unless either the `--pending-deprecation` command line flag, or the
 `NODE_PENDING_DEPRECATION=1` environment variable, is set. Pending deprecations
 are used to provide a kind of selective "early warning" mechanism that
 developers may leverage to detect deprecated API usage.
@@ -545,9 +545,9 @@ added: v7.7.0
 If `--use-openssl-ca` is enabled, this overrides and sets OpenSSL's directory
 containing trusted certificates.
 
-*Note*: Be aware that unless the child environment is explicitly set, this
-environment variable will be inherited by any child processes, and if they use
-OpenSSL, it may cause them to trust the same CAs as node.
+Be aware that unless the child environment is explicitly set, this environment
+variable will be inherited by any child processes, and if they use OpenSSL, it
+may cause them to trust the same CAs as node.
 
 ### `SSL_CERT_FILE=file`
 <!-- YAML
@@ -557,9 +557,9 @@ added: v7.7.0
 If `--use-openssl-ca` is enabled, this overrides and sets OpenSSL's file
 containing trusted certificates.
 
-*Note*: Be aware that unless the child environment is explicitly set, this
-environment variable will be inherited by any child processes, and if they use
-OpenSSL, it may cause them to trust the same CAs as node.
+Be aware that unless the child environment is explicitly set, this environment
+variable will be inherited by any child processes, and if they use OpenSSL, it
+may cause them to trust the same CAs as node.
 
 ### `NODE_REDIRECT_WARNINGS=file`
 <!-- YAML

doc/api/cluster.md

@@ -97,9 +97,9 @@ Node.js process and a cluster worker differs:
    port is random the first time, but predictable thereafter. To listen
    on a unique port, generate a port number based on the cluster worker ID.
 
-*Note*: Node.js does not provide routing logic. It is, therefore important to
-design an application such that it does not rely too heavily on in-memory data
-objects for things like sessions and login.
+Node.js does not provide routing logic. It is, therefore important to design an
+application such that it does not rely too heavily on in-memory data objects for
+things like sessions and login.
 
 Because workers are all separate processes, they can be killed or
 re-spawned depending on a program's needs, without affecting other

doc/api/console.md

@@ -127,9 +127,8 @@ console.assert(false, 'Whoops %s work', 'didn\'t');
 // Assertion failed: Whoops didn't work
 ```
 
-*Note*: Calling `console.assert()` with a falsy assertion will only cause the
-`message` to be printed to the console without interrupting execution of
-subsequent code.
+Calling `console.assert()` with a falsy assertion will only cause the `message`
+to be printed to the console without interrupting execution of subsequent code.
 
 ### console.clear()
 <!-- YAML
@@ -139,8 +138,8 @@ added: v8.3.0
 When `stdout` is a TTY, calling `console.clear()` will attempt to clear the
 TTY. When `stdout` is not a TTY, this method does nothing.
 
-*Note*: The specific operation of `console.clear()` can vary across operating
-systems and terminal types. For most Linux operating systems, `console.clear()`
+The specific operation of `console.clear()` can vary across operating systems
+and terminal types. For most Linux operating systems, `console.clear()`
 operates similarly to the `clear` shell command. On Windows, `console.clear()`
 will clear only the output in the current terminal viewport for the Node.js
 binary.