Skip to content

Commit

Permalink
doc: harmonize version list style in YAML comments
Browse files Browse the repository at this point in the history
Refs: nodejs/remark-preset-lint-node#139

PR-URL: #35454
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Ujjwal Sharma <[email protected]>
Reviewed-By: Trivikram Kamat <[email protected]>
Reviewed-By: Benjamin Gruenbaum <[email protected]>
Reviewed-By: Khaidi Chu <[email protected]>
Reviewed-By: Michael Dawson <[email protected]>
  • Loading branch information
aduh95 authored and BethGriggs committed Oct 14, 2020
1 parent b3f15b7 commit 28c94ca
Show file tree
Hide file tree
Showing 13 changed files with 77 additions and 31 deletions.
44 changes: 33 additions & 11 deletions doc/api/assert.md
Original file line number Diff line number Diff line change
Expand Up @@ -318,13 +318,19 @@ changes:
- 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
- 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 @@ -438,13 +444,17 @@ changes:
- 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
- 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 @@ -666,7 +676,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 @@ -975,13 +987,19 @@ changes:
- 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
- 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 @@ -1057,13 +1075,17 @@ changes:
- 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
- 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
8 changes: 6 additions & 2 deletions doc/api/buffer.md
Original file line number Diff line number Diff line change
Expand Up @@ -1128,7 +1128,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 @@ -1985,7 +1987,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
Original file line number Diff line number Diff line change
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
4 changes: 3 additions & 1 deletion doc/api/events.md
Original file line number Diff line number Diff line change
Expand Up @@ -291,7 +291,9 @@ myEmitter.emit('event');
<!-- YAML
added: v0.9.3
changes:
- version: v6.1.0, v4.7.0
- version:
- v6.1.0
- v4.7.0
pr-url: https://github.com/nodejs/node/pull/6394
description: For listeners attached using `.once()`, the `listener` argument
now yields the original listener function.
Expand Down
8 changes: 6 additions & 2 deletions doc/api/http.md
Original file line number Diff line number Diff line change
Expand Up @@ -1792,7 +1792,9 @@ changes:
pr-url: https://github.com/nodejs/node/pull/25974
description: Return `this` from `writeHead()` to allow chaining with
`end()`.
- version: v5.11.0, v4.4.5
- version:
- v5.11.0
- v4.4.5
pr-url: https://github.com/nodejs/node/pull/6291
description: A `RangeError` is thrown if `statusCode` is not a number in
the range `[100, 999]`.
Expand Down Expand Up @@ -2182,7 +2184,9 @@ changes:
- version: v13.3.0
pr-url: https://github.com/nodejs/node/pull/30570
description: The `maxHeaderSize` option is supported now.
- version: v9.6.0, v8.12.0
- version:
- v9.6.0
- v8.12.0
pr-url: https://github.com/nodejs/node/pull/15752
description: The `options` argument is supported now.
-->
Expand Down
2 changes: 1 addition & 1 deletion doc/api/modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -903,8 +903,8 @@ loading.
<!-- YAML
added: v0.1.16
deprecated:
- v12.19.0
- v14.6.0
- v12.19.0
-->

> Stability: 0 - Deprecated: Please use [`require.main`][] and
Expand Down
2 changes: 1 addition & 1 deletion doc/api/n-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -5569,8 +5569,8 @@ a specific `napi_env`.
### napi_get_uv_event_loop
<!-- YAML
added:
- v8.10.0
- v9.3.0
- v8.10.0
napiVersion: 2
-->

Expand Down
12 changes: 6 additions & 6 deletions doc/api/packages.md
Original file line number Diff line number Diff line change
Expand Up @@ -800,12 +800,12 @@ The following fields in `package.json` files are used in Node.js:
### `"name"`
<!-- YAML
added:
- v12.16.0
- v13.1.0
- v12.16.0
changes:
- version:
- v12.16.0
- v13.6.0
- v12.16.0
pr-url: https://github.com/nodejs/node/pull/31002
description: Remove the `--experimental-resolve-self` option.
-->
Expand All @@ -830,8 +830,8 @@ The `"name"` field can be used in addition to the [`"exports"`][] field to
added: v12.0.0
changes:
- version:
- v12.17.0
- v13.2.0
- v12.17.0
pr-url: https://github.com/nodejs/node/pull/29866
description: Unflag `--experimental-modules`.
-->
Expand Down Expand Up @@ -882,18 +882,18 @@ as ES modules and `.cjs` files are always treated as CommonJS.
added: v12.7.0
changes:
- version:
- v12.16.0
- v13.2.0
- v12.16.0
pr-url: https://github.com/nodejs/node/pull/29978
description: Implement conditional exports.
- version:
- v12.16.0
- v13.7.0
- v12.16.0
pr-url: https://github.com/nodejs/node/pull/31001
description: Remove the `--experimental-conditional-exports` option.
- version:
- v12.16.0
- v13.7.0
- v12.16.0
pr-url: https://github.com/nodejs/node/pull/31008
description: Implement logical conditional exports ordering.
- version:
Expand Down
4 changes: 3 additions & 1 deletion doc/api/process.md
Original file line number Diff line number Diff line change
Expand Up @@ -2428,7 +2428,9 @@ flag's behavior.
<!-- YAML
added: v0.1.19
changes:
- version: v14.0.0
- version:
- v14.0.0
- v12.19.0
pr-url: https://github.com/nodejs/node/pull/32499
description: Calling `process.umask()` with no arguments is deprecated.
Expand Down
4 changes: 3 additions & 1 deletion doc/api/querystring.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,9 @@ changes:
- version: v6.0.0
pr-url: https://github.com/nodejs/node/pull/6055
description: The returned object no longer inherits from `Object.prototype`.
- version: v6.0.0, v4.2.4
- version:
- v6.0.0
- v4.2.4
pr-url: https://github.com/nodejs/node/pull/3807
description: The `eq` parameter may now have a length of more than `1`.
-->
Expand Down
4 changes: 3 additions & 1 deletion doc/api/readline.md
Original file line number Diff line number Diff line change
Expand Up @@ -471,7 +471,9 @@ changes:
- version: v13.9.0
pr-url: https://github.com/nodejs/node/pull/31318
description: The `tabSize` option is supported now.
- version: v8.3.0, 6.11.4
- version:
- v8.3.0
- v6.11.4
pr-url: https://github.com/nodejs/node/pull/13497
description: Remove max limit of `crlfDelay` option.
- version: v6.6.0
Expand Down
4 changes: 3 additions & 1 deletion doc/api/tls.md
Original file line number Diff line number Diff line change
Expand Up @@ -1382,7 +1382,9 @@ changes:
pr-url: https://github.com/nodejs/node/pull/11984
description: The `ALPNProtocols` option can be a `TypedArray` or
`DataView` now.
- version: v5.3.0, v4.7.0
- version:
- v5.3.0
- v4.7.0
pr-url: https://github.com/nodejs/node/pull/4246
description: The `secureContext` option is supported now.
- version: v5.0.0
Expand Down
4 changes: 3 additions & 1 deletion doc/api/url.md
Original file line number Diff line number Diff line change
Expand Up @@ -1268,7 +1268,9 @@ changes:
pr-url: https://github.com/nodejs/node/pull/8215
description: The `auth` fields are now kept intact when `from` and `to`
refer to the same host.
- version: v6.5.0, v4.6.2
- version:
- v6.5.0
- v4.6.2
pr-url: https://github.com/nodejs/node/pull/8214
description: The `port` field is copied correctly now.
- version: v6.0.0
Expand Down

0 comments on commit 28c94ca

Please sign in to comment.