From 28c94ca1236054b696b8853475662009f2807638 Mon Sep 17 00:00:00 2001 From: Antoine du Hamel Date: Thu, 1 Oct 2020 20:23:33 +0200 Subject: [PATCH] doc: harmonize version list style in YAML comments Refs: https://github.com/nodejs/remark-preset-lint-node/pull/139 PR-URL: https://github.com/nodejs/node/pull/35454 Reviewed-By: Rich Trott Reviewed-By: Luigi Pinca Reviewed-By: Ujjwal Sharma Reviewed-By: Trivikram Kamat Reviewed-By: Benjamin Gruenbaum Reviewed-By: Khaidi Chu Reviewed-By: Michael Dawson --- doc/api/assert.md | 44 ++++++++++++++++++++++++++++++---------- doc/api/buffer.md | 8 ++++++-- doc/api/child_process.md | 8 ++++++-- doc/api/events.md | 4 +++- doc/api/http.md | 8 ++++++-- doc/api/modules.md | 2 +- doc/api/n-api.md | 2 +- doc/api/packages.md | 12 +++++------ doc/api/process.md | 4 +++- doc/api/querystring.md | 4 +++- doc/api/readline.md | 4 +++- doc/api/tls.md | 4 +++- doc/api/url.md | 4 +++- 13 files changed, 77 insertions(+), 31 deletions(-) diff --git a/doc/api/assert.md b/doc/api/assert.md index ea5e6034509227..58e41723ee49d5 100644 --- a/doc/api/assert.md +++ b/doc/api/assert.md @@ -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. --> @@ -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. --> @@ -666,7 +676,9 @@ assert.doesNotReject(Promise.reject(new TypeError('Wrong value'))) @@ -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. --> diff --git a/doc/api/buffer.md b/doc/api/buffer.md index f3952a4b552e5f..118ebf86e77e0c 100644 --- a/doc/api/buffer.md +++ b/doc/api/buffer.md @@ -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. @@ -1985,7 +1987,9 @@ console.log(buf.subarray(-5, -2).toString()); @@ -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 diff --git a/doc/api/events.md b/doc/api/events.md index 77ba17f6561a5b..ba83c8ff90ad60 100644 --- a/doc/api/events.md +++ b/doc/api/events.md @@ -291,7 +291,9 @@ myEmitter.emit('event'); diff --git a/doc/api/modules.md b/doc/api/modules.md index 2e239c23693146..31726a9434e4ac 100644 --- a/doc/api/modules.md +++ b/doc/api/modules.md @@ -903,8 +903,8 @@ loading. > Stability: 0 - Deprecated: Please use [`require.main`][] and diff --git a/doc/api/n-api.md b/doc/api/n-api.md index 13b9b199b64624..f332a37836f050 100644 --- a/doc/api/n-api.md +++ b/doc/api/n-api.md @@ -5569,8 +5569,8 @@ a specific `napi_env`. ### napi_get_uv_event_loop diff --git a/doc/api/packages.md b/doc/api/packages.md index 5593a3c082f943..5e2e58239067bf 100644 --- a/doc/api/packages.md +++ b/doc/api/packages.md @@ -800,12 +800,12 @@ The following fields in `package.json` files are used in Node.js: ### `"name"` @@ -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`. --> @@ -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: diff --git a/doc/api/process.md b/doc/api/process.md index bfe9df10d685d5..452da15878fd49 100644 --- a/doc/api/process.md +++ b/doc/api/process.md @@ -2428,7 +2428,9 @@ flag's behavior. diff --git a/doc/api/readline.md b/doc/api/readline.md index 2e82fdf91a1f10..d572eb4bb29f9b 100644 --- a/doc/api/readline.md +++ b/doc/api/readline.md @@ -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 diff --git a/doc/api/tls.md b/doc/api/tls.md index cae48c345a3a06..a55847ec3c736d 100644 --- a/doc/api/tls.md +++ b/doc/api/tls.md @@ -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 diff --git a/doc/api/url.md b/doc/api/url.md index d0cd0346b239c1..dff038976fba63 100644 --- a/doc/api/url.md +++ b/doc/api/url.md @@ -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