diff options
author | Antoine du Hamel <duhamelantoine1995@gmail.com> | 2020-10-01 20:23:33 +0200 |
---|---|---|
committer | Node.js GitHub Bot <github-bot@iojs.org> | 2020-10-09 18:46:45 +0000 |
commit | 125523bffe9e5fbc14af185da6f682e08c05b1ba (patch) | |
tree | ca966e0aab698ccd3086157d02422aff8cb0f57f /doc/api | |
parent | 6eace7749dff0e6b94b37af3496e5b4051051bc5 (diff) | |
download | node-new-125523bffe9e5fbc14af185da6f682e08c05b1ba.tar.gz |
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 <rtrott@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ujjwal Sharma <ryzokuken@disroot.org>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Reviewed-By: Khaidi Chu <i@2333.moe>
Reviewed-By: Michael Dawson <midawson@redhat.com>
Diffstat (limited to 'doc/api')
-rw-r--r-- | doc/api/assert.md | 44 | ||||
-rw-r--r-- | doc/api/buffer.md | 8 | ||||
-rw-r--r-- | doc/api/child_process.md | 8 | ||||
-rw-r--r-- | doc/api/events.md | 4 | ||||
-rw-r--r-- | doc/api/http.md | 8 | ||||
-rw-r--r-- | doc/api/modules.md | 2 | ||||
-rw-r--r-- | doc/api/n-api.md | 2 | ||||
-rw-r--r-- | doc/api/packages.md | 12 | ||||
-rw-r--r-- | doc/api/process.md | 3 | ||||
-rw-r--r-- | doc/api/querystring.md | 4 | ||||
-rw-r--r-- | doc/api/readline.md | 4 | ||||
-rw-r--r-- | doc/api/tls.md | 4 | ||||
-rw-r--r-- | doc/api/url.md | 4 |
13 files changed, 75 insertions, 32 deletions
diff --git a/doc/api/assert.md b/doc/api/assert.md index d5bfd5b8df..df4d795bec 100644 --- a/doc/api/assert.md +++ b/doc/api/assert.md @@ -334,13 +334,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. --> @@ -454,13 +460,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. --> @@ -682,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 @@ -991,13 +1003,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. --> @@ -1073,13 +1091,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 7167b3b52a..15279fab19 100644 --- a/doc/api/buffer.md +++ b/doc/api/buffer.md @@ -1141,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. @@ -2014,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. diff --git a/doc/api/child_process.md b/doc/api/child_process.md index c180176353..bfe7850ad0 100644 --- a/doc/api/child_process.md +++ b/doc/api/child_process.md @@ -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`. --> @@ -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 7ace75fa65..5de7e06840 100644 --- a/doc/api/events.md +++ b/doc/api/events.md @@ -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. diff --git a/doc/api/http.md b/doc/api/http.md index 2eed99fe89..4753cf629e 100644 --- a/doc/api/http.md +++ b/doc/api/http.md @@ -1803,7 +1803,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]`. @@ -2195,7 +2197,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. --> diff --git a/doc/api/modules.md b/doc/api/modules.md index 3a46aca8ef..9138826fd2 100644 --- a/doc/api/modules.md +++ b/doc/api/modules.md @@ -902,8 +902,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 diff --git a/doc/api/n-api.md b/doc/api/n-api.md index 1118dbc9ef..df34de024a 100644 --- a/doc/api/n-api.md +++ b/doc/api/n-api.md @@ -5591,8 +5591,8 @@ a specific `napi_env`. ### napi_get_uv_event_loop <!-- YAML added: - - v8.10.0 - v9.3.0 + - v8.10.0 napiVersion: 2 --> diff --git a/doc/api/packages.md b/doc/api/packages.md index 5593a3c082..5e2e582390 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"` <!-- 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. --> @@ -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 ac6f0adcb0..7290d561c9 100644 --- a/doc/api/process.md +++ b/doc/api/process.md @@ -2450,10 +2450,9 @@ flag's behavior. <!-- YAML added: v0.1.19 changes: - - version: v14.0.0 - version: - - v12.19.0 - v14.0.0 + - v12.19.0 pr-url: https://github.com/nodejs/node/pull/32499 description: Calling `process.umask()` with no arguments is deprecated. diff --git a/doc/api/querystring.md b/doc/api/querystring.md index 03ee78aad0..34d7675a9c 100644 --- a/doc/api/querystring.md +++ b/doc/api/querystring.md @@ -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`. --> diff --git a/doc/api/readline.md b/doc/api/readline.md index 2e82fdf91a..d572eb4bb2 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 a8d44e9aac..3e9bb42aee 100644 --- a/doc/api/tls.md +++ b/doc/api/tls.md @@ -1374,7 +1374,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 d2ba4f3b09..f3a76a6c45 100644 --- a/doc/api/url.md +++ b/doc/api/url.md @@ -1286,7 +1286,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 |