Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: Harmonize YAML comments #35454

Closed
wants to merge 6 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
67 changes: 45 additions & 22 deletions doc/api/assert.md
Expand Up @@ -15,10 +15,11 @@ added: v9.9.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/34001
description: Exposed as `require('assert/strict')`
description: Exposed as `require('assert/strict')`.
- version:
- v13.9.0
- v12.16.2
pr-url: https://github.com/nodejs/node/pull/31635
description: Changed "strict mode" to "strict assertion mode" and "legacy
mode" to "legacy assertion mode" to avoid confusion with the
more usual meaning of "strict mode".
Expand Down Expand Up @@ -329,17 +330,23 @@ changes:
minor comparison adjustments to make the check less surprising.
- version: v9.0.0
pr-url: https://github.com/nodejs/node/pull/15001
description: The `Error` names and messages are now properly compared
description: The `Error` names and messages are now properly compared.
- version: v8.0.0
pr-url: https://github.com/nodejs/node/pull/12142
description: The `Set` and `Map` content is also compared
- version: v6.4.0, v4.7.1
description: The `Set` and `Map` content is also compared.
- version:
- v6.4.0
- v4.7.1
pr-url: https://github.com/nodejs/node/pull/8002
description: Typed array slices are handled correctly now.
- version: v6.1.0, v4.5.0
- version:
- v6.1.0
- v4.5.0
pr-url: https://github.com/nodejs/node/pull/6432
description: Objects with circular references can be used as inputs now.
- version: v5.10.1, v4.4.3
- version:
- v5.10.1
- v4.4.3
pr-url: https://github.com/nodejs/node/pull/5910
description: Handle non-`Uint8Array` typed arrays correctly.
-->
Expand Down Expand Up @@ -449,17 +456,21 @@ changes:
comparison.
- version: v8.5.0
pr-url: https://github.com/nodejs/node/pull/15001
description: The `Error` names and messages are now properly compared
description: The `Error` names and messages are now properly compared.
- version: v8.0.0
pr-url: https://github.com/nodejs/node/pull/12142
description: The `Set` and `Map` content is also compared
- version: v6.4.0, v4.7.1
description: The `Set` and `Map` content is also compared.
- version:
- v6.4.0
- v4.7.1
pr-url: https://github.com/nodejs/node/pull/8002
description: Typed array slices are handled correctly now.
- version: v6.1.0
pr-url: https://github.com/nodejs/node/pull/6432
description: Objects with circular references can be used as inputs now.
- version: v5.10.1, v4.4.3
- version:
- v5.10.1
- v4.4.3
pr-url: https://github.com/nodejs/node/pull/5910
description: Handle non-`Uint8Array` typed arrays correctly.
-->
Expand Down Expand Up @@ -681,7 +692,9 @@ assert.doesNotReject(Promise.reject(new TypeError('Wrong value')))
<!-- YAML
added: v0.1.21
changes:
- version: v5.11.0, v4.4.5
- version:
- v5.11.0
- v4.4.5
pr-url: https://github.com/nodejs/node/pull/2407
description: The `message` parameter is respected now.
- version: v4.2.0
Expand Down Expand Up @@ -986,17 +999,23 @@ changes:
NaN.
- version: v9.0.0
pr-url: https://github.com/nodejs/node/pull/15001
description: The `Error` names and messages are now properly compared
description: The `Error` names and messages are now properly compared.
- version: v8.0.0
pr-url: https://github.com/nodejs/node/pull/12142
description: The `Set` and `Map` content is also compared
- version: v6.4.0, v4.7.1
description: The `Set` and `Map` content is also compared.
- version:
- v6.4.0
- v4.7.1
pr-url: https://github.com/nodejs/node/pull/8002
description: Typed array slices are handled correctly now.
- version: v6.1.0, v4.5.0
- version:
- v6.1.0
- v4.5.0
pr-url: https://github.com/nodejs/node/pull/6432
description: Objects with circular references can be used as inputs now.
- version: v5.10.1, v4.4.3
- version:
- v5.10.1
- v4.4.3
pr-url: https://github.com/nodejs/node/pull/5910
description: Handle non-`Uint8Array` typed arrays correctly.
-->
Expand Down Expand Up @@ -1068,17 +1087,21 @@ changes:
comparison.
- version: v9.0.0
pr-url: https://github.com/nodejs/node/pull/15001
description: The `Error` names and messages are now properly compared
description: The `Error` names and messages are now properly compared.
- version: v8.0.0
pr-url: https://github.com/nodejs/node/pull/12142
description: The `Set` and `Map` content is also compared
- version: v6.4.0, v4.7.1
description: The `Set` and `Map` content is also compared.
- version:
- v6.4.0
- v4.7.1
pr-url: https://github.com/nodejs/node/pull/8002
description: Typed array slices are handled correctly now.
- version: v6.1.0
pr-url: https://github.com/nodejs/node/pull/6432
description: Objects with circular references can be used as inputs now.
- version: v5.10.1, v4.4.3
- version:
- v5.10.1
- v4.4.3
pr-url: https://github.com/nodejs/node/pull/5910
description: Handle non-`Uint8Array` typed arrays correctly.
-->
Expand Down Expand Up @@ -1153,7 +1176,7 @@ added: v0.1.21
changes:
- version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/17003
description: Used comparison changed from Strict Equality to `Object.is()`
description: Used comparison changed from Strict Equality to `Object.is()`.
-->

* `actual` {any}
Expand Down Expand Up @@ -1332,7 +1355,7 @@ added: v0.1.21
changes:
- version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/17003
description: Used comparison changed from Strict Equality to `Object.is()`
description: Used comparison changed from Strict Equality to `Object.is()`.
-->

* `actual` {any}
Expand Down
2 changes: 1 addition & 1 deletion doc/api/async_hooks.md
Expand Up @@ -546,7 +546,7 @@ added: v8.1.0
changes:
- version: v8.2.0
pr-url: https://github.com/nodejs/node/pull/13490
description: Renamed from `currentId`
description: Renamed from `currentId`.
-->

* Returns: {number} The `asyncId` of the current execution context. Useful to
Expand Down
12 changes: 6 additions & 6 deletions doc/api/buffer.md
Expand Up @@ -776,10 +776,6 @@ This is the size (in bytes) of pre-allocated internal `Buffer` instances used
for pooling. This value may be modified.

### `buf[index]`
<!-- YAML
type: property
name: [index]
-->

* `index` {integer}

Expand Down Expand Up @@ -1145,7 +1141,9 @@ changes:
- version: v8.0.0
pr-url: https://github.com/nodejs/node/pull/10236
description: The `value` can now be a `Uint8Array`.
- version: v5.7.0, v4.4.0
- version:
- v5.7.0
- v4.4.0
pr-url: https://github.com/nodejs/node/pull/4803
description: When `encoding` is being passed, the `byteOffset` parameter
is no longer required.
Expand Down Expand Up @@ -2018,7 +2016,9 @@ console.log(buf.subarray(-5, -2).toString());
<!-- YAML
added: v0.3.0
changes:
- version: v7.1.0, v6.9.2
- version:
- v7.1.0
- v6.9.2
pr-url: https://github.com/nodejs/node/pull/9341
description: Coercing the offsets to integers now handles values outside
the 32-bit integer range properly.
Expand Down
8 changes: 6 additions & 2 deletions doc/api/child_process.md
Expand Up @@ -729,7 +729,9 @@ changes:
- version: v8.0.0
pr-url: https://github.com/nodejs/node/pull/10653
description: The `input` option can now be a `Uint8Array`.
- version: v6.2.1, v4.5.0
- version:
- v6.2.1
- v4.5.0
pr-url: https://github.com/nodejs/node/pull/6939
description: The `encoding` option can now explicitly be set to `buffer`.
-->
Expand Down Expand Up @@ -856,7 +858,9 @@ changes:
- version: v8.0.0
pr-url: https://github.com/nodejs/node/pull/10653
description: The `input` option can now be a `Uint8Array`.
- version: v6.2.1, v4.5.0
- version:
- v6.2.1
- v4.5.0
pr-url: https://github.com/nodejs/node/pull/6939
description: The `encoding` option can now explicitly be set to `buffer`.
- version: v5.7.0
Expand Down
14 changes: 7 additions & 7 deletions doc/api/cli.md
Expand Up @@ -290,7 +290,7 @@ changes:
- version: v13.6.0
pr-url: https://github.com/nodejs/node/pull/30980
description: changed from `--experimental-wasi-unstable-preview0` to
`--experimental-wasi-unstable-preview1`
`--experimental-wasi-unstable-preview1`.
-->

Enable experimental WebAssembly System Interface (WASI) support.
Expand Down Expand Up @@ -694,7 +694,7 @@ changes:
- version: v12.0.0
pr-url: https://github.com/nodejs/node/pull/27312
description: Changed from `--diagnostic-report-directory` to
`--report-directory`
`--report-directory`.
-->

Location at which the report will be generated.
Expand All @@ -711,7 +711,7 @@ changes:
- version: v12.0.0
pr-url: https://github.com/nodejs/node/pull/27312
description: changed from `--diagnostic-report-filename` to
`--report-filename`
`--report-filename`.
-->

Name of the file to which the report will be written.
Expand All @@ -729,7 +729,7 @@ changes:
- version: v12.0.0
pr-url: https://github.com/nodejs/node/pull/27312
description: changed from `--diagnostic-report-on-fatalerror` to
`--report-on-fatalerror`
`--report-on-fatalerror`.
-->

Enables the report to be triggered on fatal errors (internal errors within
Expand All @@ -750,7 +750,7 @@ changes:
- version: v12.0.0
pr-url: https://github.com/nodejs/node/pull/27312
description: changed from `--diagnostic-report-on-signal` to
`--report-on-signal`
`--report-on-signal`.
-->

Enables report to be generated upon receiving the specified (or predefined)
Expand All @@ -769,7 +769,7 @@ changes:
- version: v12.0.0
pr-url: https://github.com/nodejs/node/pull/27312
description: changed from `--diagnostic-report-signal` to
`--report-signal`
`--report-signal`.
-->

Sets or resets the signal for report generation (not supported on Windows).
Expand All @@ -787,7 +787,7 @@ changes:
- version: v12.0.0
pr-url: https://github.com/nodejs/node/pull/27312
description: changed from `--diagnostic-report-uncaught-exception` to
`--report-uncaught-exception`
`--report-uncaught-exception`.
-->

Enables report to be generated on uncaught exceptions. Useful when inspecting
Expand Down
16 changes: 8 additions & 8 deletions doc/api/crypto.md
Expand Up @@ -514,7 +514,7 @@ added: v1.0.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/35093
decription: The buffer argument can be a string or ArrayBuffer and is
description: The buffer argument can be a string or ArrayBuffer and is
limited to no more than 2 ** 31 - 1 bytes.
- version: v7.2.0
pr-url: https://github.com/nodejs/node/pull/9398
Expand Down Expand Up @@ -543,7 +543,7 @@ added: v1.0.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/35093
decription: The buffer argument can be a string or ArrayBuffer and is
description: The buffer argument can be a string or ArrayBuffer and is
limited to no more than 2 ** 31 - 1 bytes.
- version: v11.0.0
pr-url: https://github.com/nodejs/node/pull/17825
Expand Down Expand Up @@ -882,13 +882,13 @@ console.log(uncompressedKey === ecdh.getPublicKey('hex'));
<!-- YAML
added: v0.11.14
changes:
- version: v6.0.0
pr-url: https://github.com/nodejs/node/pull/5522
description: The default `inputEncoding` changed from `binary` to `utf8`
- version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/16849
description: Changed error format to better support invalid public key
error
error.
- version: v6.0.0
pr-url: https://github.com/nodejs/node/pull/5522
description: The default `inputEncoding` changed from `binary` to `utf8`.
-->

* `otherPublicKey` {string|ArrayBuffer|Buffer|TypedArray|DataView}
Expand Down Expand Up @@ -1295,14 +1295,14 @@ changes:
description: Added support for `'dh'`.
- version: v12.0.0
pr-url: https://github.com/nodejs/node/pull/26960
description: Added support for `'rsa-pss'`
description: Added support for `'rsa-pss'`.
- version: v12.0.0
pr-url: https://github.com/nodejs/node/pull/26786
description: This property now returns `undefined` for KeyObject
instances of unrecognized type instead of aborting.
- version: v12.0.0
pr-url: https://github.com/nodejs/node/pull/26774
description: Added support for `'x25519'` and `'x448'`
description: Added support for `'x25519'` and `'x448'`.
- version: v12.0.0
pr-url: https://github.com/nodejs/node/pull/26319
description: Added support for `'ed25519'` and `'ed448'`.
Expand Down