doc: use new api linter

Author: avivkeller

doc/README.md

@@ -15,7 +15,7 @@ professionalism across all documents.
 7. [Formatting](#formatting)
 8. [Product and Project Naming](#product-and-project-naming)
 
-***
+---
 
 ## General guidelines
 
@@ -38,7 +38,7 @@ professionalism across all documents.
 
 * Validate documentation changes using `make test-doc -j` or `vcbuild test-doc`.
 
-***
+---
 
 ## Writing style
 
@@ -68,7 +68,7 @@ professionalism across all documents.
 * Use precise technical terms and avoid colloquialisms.
 * Define any specialized terms or acronyms at first use.
 
-***
+---
 
 ## Punctuation
 
@@ -87,7 +87,7 @@ professionalism across all documents.
 * Use colons to introduce lists or explanations.
 * Use semicolons to link closely related independent clauses.
 
-***
+---
 
 ## Document structure
 
@@ -109,7 +109,7 @@ professionalism across all documents.
 
 * Use tables to present structured information clearly. Ensure they are readable in plain text.
 
-***
+---
 
 ## API documentation
 
@@ -129,7 +129,7 @@ professionalism across all documents.
     * `byteOffset` {integer} Index of first byte to expose. **Default:** `0`.
     ```
 
-***
+---
 
 ## Code blocks
 
@@ -165,7 +165,7 @@ professionalism across all documents.
 * Use comments to explain complex logic within code examples.
 * Follow the standard commenting style of the respective language.
 
-***
+---
 
 ## Formatting
 
@@ -198,7 +198,7 @@ professionalism across all documents.
   * Returns: {AsyncHook} A reference to `asyncHook`.
   ```
 
-***
+---
 
 ## Product and project naming
 
@@ -225,7 +225,7 @@ professionalism across all documents.
 
 For topics not addressed here, please consult the [Microsoft Writing Style Guide][].
 
-***
+---
 
 [Microsoft Writing Style Guide]: https://learn.microsoft.com/en-us/style-guide/welcome/
 [US spelling]: https://learn.microsoft.com/en-us/style-guide/word-choice/use-us-spelling-avoid-non-english-words

doc/api/buffer.md

@@ -1024,7 +1024,7 @@ changes:
     description: The elements of `list` can now be `Uint8Array`s.
 -->
 
-* `list` {Buffer\[] | Uint8Array\[]} List of `Buffer` or {Uint8Array}
+* `list` {Buffer\[]|Uint8Array\[]} List of `Buffer` or {Uint8Array}
   instances to concatenate.
 * `totalLength` {integer} Total length of the `Buffer` instances in `list`
   when concatenated.
@@ -5233,7 +5233,7 @@ added:
   - v18.15.0
 -->
 
-* `input` {Buffer | ArrayBuffer | TypedArray} The input to validate.
+* `input` {Buffer|ArrayBuffer|TypedArray} The input to validate.
 * Returns: {boolean}
 
 This function returns `true` if `input` contains only valid ASCII-encoded data,
@@ -5249,7 +5249,7 @@ added:
   - v18.14.0
 -->
 
-* `input` {Buffer | ArrayBuffer | TypedArray} The input to validate.
+* `input` {Buffer|ArrayBuffer|TypedArray} The input to validate.
 * Returns: {boolean}
 
 This function returns `true` if `input` contains only valid UTF-8-encoded data,

doc/api/crypto.md

@@ -568,7 +568,7 @@ added: v0.1.94
 -->
 
 * `outputEncoding` {string} The [encoding][] of the return value.
-* Returns: {Buffer | string} Any remaining enciphered contents.
+* Returns: {Buffer|string} Any remaining enciphered contents.
   If `outputEncoding` is specified, a string is
   returned. If an `outputEncoding` is not provided, a [`Buffer`][] is returned.
 
@@ -651,7 +651,7 @@ changes:
 * `data` {string|Buffer|TypedArray|DataView}
 * `inputEncoding` {string} The [encoding][] of the data.
 * `outputEncoding` {string} The [encoding][] of the return value.
-* Returns: {Buffer | string}
+* Returns: {Buffer|string}
 
 Updates the cipher with `data`. If the `inputEncoding` argument is given,
 the `data`
@@ -878,7 +878,7 @@ added: v0.1.94
 -->
 
 * `outputEncoding` {string} The [encoding][] of the return value.
-* Returns: {Buffer | string} Any remaining deciphered contents.
+* Returns: {Buffer|string} Any remaining deciphered contents.
   If `outputEncoding` is specified, a string is
   returned. If an `outputEncoding` is not provided, a [`Buffer`][] is returned.
 
@@ -997,7 +997,7 @@ changes:
 * `data` {string|Buffer|TypedArray|DataView}
 * `inputEncoding` {string} The [encoding][] of the `data` string.
 * `outputEncoding` {string} The [encoding][] of the return value.
-* Returns: {Buffer | string}
+* Returns: {Buffer|string}
 
 Updates the decipher with `data`. If the `inputEncoding` argument is given,
 the `data`
@@ -1086,7 +1086,7 @@ added: v0.5.0
 * `otherPublicKey` {string|ArrayBuffer|Buffer|TypedArray|DataView}
 * `inputEncoding` {string} The [encoding][] of an `otherPublicKey` string.
 * `outputEncoding` {string} The [encoding][] of the return value.
-* Returns: {Buffer | string}
+* Returns: {Buffer|string}
 
 Computes the shared secret using `otherPublicKey` as the other
 party's public key and returns the computed shared secret. The supplied
@@ -1106,7 +1106,7 @@ added: v0.5.0
 -->
 
 * `encoding` {string} The [encoding][] of the return value.
-* Returns: {Buffer | string}
+* Returns: {Buffer|string}
 
 Generates private and public Diffie-Hellman key values unless they have been
 generated or computed already, and returns
@@ -1126,7 +1126,7 @@ added: v0.5.0
 -->
 
 * `encoding` {string} The [encoding][] of the return value.
-* Returns: {Buffer | string}
+* Returns: {Buffer|string}
 
 Returns the Diffie-Hellman generator in the specified `encoding`.
 If `encoding` is provided a string is
@@ -1139,7 +1139,7 @@ added: v0.5.0
 -->
 
 * `encoding` {string} The [encoding][] of the return value.
-* Returns: {Buffer | string}
+* Returns: {Buffer|string}
 
 Returns the Diffie-Hellman prime in the specified `encoding`.
 If `encoding` is provided a string is
@@ -1152,7 +1152,7 @@ added: v0.5.0
 -->
 
 * `encoding` {string} The [encoding][] of the return value.
-* Returns: {Buffer | string}
+* Returns: {Buffer|string}
 
 Returns the Diffie-Hellman private key in the specified `encoding`.
 If `encoding` is provided a
@@ -1165,7 +1165,7 @@ added: v0.5.0
 -->
 
 * `encoding` {string} The [encoding][] of the return value.
-* Returns: {Buffer | string}
+* Returns: {Buffer|string}
 
 Returns the Diffie-Hellman public key in the specified `encoding`.
 If `encoding` is provided a
@@ -1325,7 +1325,7 @@ added: v10.0.0
 * `inputEncoding` {string} The [encoding][] of the `key` string.
 * `outputEncoding` {string} The [encoding][] of the return value.
 * `format` {string} **Default:** `'uncompressed'`
-* Returns: {Buffer | string}
+* Returns: {Buffer|string}
 
 Converts the EC Diffie-Hellman public key specified by `key` and `curve` to the
 format specified by `format`. The `format` argument specifies point encoding
@@ -1404,7 +1404,7 @@ changes:
 * `otherPublicKey` {string|ArrayBuffer|Buffer|TypedArray|DataView}
 * `inputEncoding` {string} The [encoding][] of the `otherPublicKey` string.
 * `outputEncoding` {string} The [encoding][] of the return value.
-* Returns: {Buffer | string}
+* Returns: {Buffer|string}
 
 Computes the shared secret using `otherPublicKey` as the other
 party's public key and returns the computed shared secret. The supplied
@@ -1431,7 +1431,7 @@ added: v0.11.14
 
 * `encoding` {string} The [encoding][] of the return value.
 * `format` {string} **Default:** `'uncompressed'`
-* Returns: {Buffer | string}
+* Returns: {Buffer|string}
 
 Generates private and public EC Diffie-Hellman key values, and returns
 the public key in the specified `format` and `encoding`. This key should be
@@ -1451,7 +1451,7 @@ added: v0.11.14
 -->
 
 * `encoding` {string} The [encoding][] of the return value.
-* Returns: {Buffer | string} The EC Diffie-Hellman in the specified `encoding`.
+* Returns: {Buffer|string} The EC Diffie-Hellman in the specified `encoding`.
 
 If `encoding` is specified, a string is returned; otherwise a [`Buffer`][] is
 returned.
@@ -1464,7 +1464,7 @@ added: v0.11.14
 
 * `encoding` {string} The [encoding][] of the return value.
 * `format` {string} **Default:** `'uncompressed'`
-* Returns: {Buffer | string} The EC Diffie-Hellman public key in the specified
+* Returns: {Buffer|string} The EC Diffie-Hellman public key in the specified
   `encoding` and `format`.
 
 The `format` argument specifies point encoding and can be `'compressed'` or
@@ -1754,7 +1754,7 @@ added: v0.1.92
 -->
 
 * `encoding` {string} The [encoding][] of the return value.
-* Returns: {Buffer | string}
+* Returns: {Buffer|string}
 
 Calculates the digest of all of the data passed to be hashed (using the
 [`hash.update()`][] method).
@@ -1915,7 +1915,7 @@ added: v0.1.94
 -->
 
 * `encoding` {string} The [encoding][] of the return value.
-* Returns: {Buffer | string}
+* Returns: {Buffer|string}
 
 Calculates the HMAC digest of all of the data passed using [`hmac.update()`][].
 If `encoding` is
@@ -2122,7 +2122,7 @@ changes:
 -->
 
 * `options` {Object}
-* Returns: {string | Buffer | Object}
+* Returns: {string|Buffer|Object}
 
 For symmetric keys, the following encoding options can be used:
 
@@ -2141,7 +2141,7 @@ For private keys, the following encoding options can be used:
 * `cipher` {string} If specified, the private key will be encrypted with
   the given `cipher` and `passphrase` using PKCS#5 v2.0 password based
   encryption.
-* `passphrase` {string | Buffer} The passphrase to use for encryption, see
+* `passphrase` {string|Buffer} The passphrase to use for encryption, see
   `cipher`.
 
 The result type depends on the selected encoding format, when PEM the
@@ -2351,7 +2351,7 @@ changes:
   * `padding` {integer}
   * `saltLength` {integer}
 * `outputEncoding` {string} The [encoding][] of the return value.
-* Returns: {Buffer | string}
+* Returns: {Buffer|string}
 
 <!--lint enable maximum-line-length remark-lint-->
 
@@ -3645,7 +3645,7 @@ changes:
     **Default:** `'pem'`.
   * `type` {string} Must be `'pkcs1'`, `'pkcs8'` or `'sec1'`. This option is
     required only if the `format` is `'der'` and ignored otherwise.
-  * `passphrase` {string | Buffer} The passphrase to use for decryption.
+  * `passphrase` {string|Buffer} The passphrase to use for decryption.
   * `encoding` {string} The string encoding to use when `key` is a string.
 * Returns: {KeyObject}
 
@@ -4006,8 +4006,8 @@ changes:
   * `privateKeyEncoding` {Object} See [`keyObject.export()`][].
 * `callback` {Function}
   * `err` {Error}
-  * `publicKey` {string | Buffer | KeyObject}
-  * `privateKey` {string | Buffer | KeyObject}
+  * `publicKey` {string|Buffer|KeyObject}
+  * `privateKey` {string|Buffer|KeyObject}
 
 Generates a new asymmetric key pair of the given `type`. See the
 supported [asymmetric key types][].
@@ -4128,8 +4128,8 @@ changes:
   * `publicKeyEncoding` {Object} See [`keyObject.export()`][].
   * `privateKeyEncoding` {Object} See [`keyObject.export()`][].
 * Returns: {Object}
-  * `publicKey` {string | Buffer | KeyObject}
-  * `privateKey` {string | Buffer | KeyObject}
+  * `publicKey` {string|Buffer|KeyObject}
+  * `privateKey` {string|Buffer|KeyObject}
 
 Generates a new asymmetric key pair of the given `type`. See the
 supported [asymmetric key types][].
@@ -5758,7 +5758,7 @@ changes:
 
 <!--lint disable maximum-line-length remark-lint-->
 
-* `algorithm` {string | null | undefined}
+* `algorithm` {string|null|undefined}
 * `data` {ArrayBuffer|Buffer|TypedArray|DataView}
 * `key` {Object|string|ArrayBuffer|Buffer|TypedArray|DataView|KeyObject|CryptoKey}
 * `callback` {Function}
@@ -5887,7 +5887,7 @@ changes:
 <!--lint disable maximum-line-length remark-lint-->
 
 * `algorithm` {string|null|undefined}
-* `data` {ArrayBuffer| Buffer|TypedArray|DataView}
+* `data` {ArrayBuffer|Buffer|TypedArray|DataView}
 * `key` {Object|string|ArrayBuffer|Buffer|TypedArray|DataView|KeyObject|CryptoKey}
 * `signature` {ArrayBuffer|Buffer|TypedArray|DataView}
 * `callback` {Function}

doc/api/deprecations.md

@@ -2619,11 +2619,13 @@ of Node.js core and was removed.
 <!-- YAML
 changes:
   - version: v11.0.0
-    pr-url:
-      - https://github.com/nodejs/node/pull/22519
-      - https://github.com/nodejs/node/pull/23017
-    description: Documentation-only deprecation
+    pr-url: https://github.com/nodejs/node/pull/22519
+    description: Deprecation revoked.
+                 Status changed to a documentation-only deprecation
                  with `--pending-deprecation` support.
+  - version: v11.0.0
+    pr-url: https://github.com/nodejs/node/pull/23017
+    description: Runtime deprecation.
 -->
 
 Type: Documentation-only (supports [`--pending-deprecation`][])

doc/api/diagnostics_channel.md

@@ -1247,7 +1247,7 @@ Emitted when a stream is received on the client.
 
 * `stream` {ClientHttp2Stream}
 * `writev` {boolean}
-* `data` {Buffer | string | Buffer\[] | Object\[]}
+* `data` {Buffer|string|Buffer\[]|Object\[]}
   * `chunk` {Buffer|string}
   * `encoding` {string}
 * `encoding` {string}