Skip to content

Commit 28c94ca

Browse files
aduh95BethGriggs
authored andcommitted
doc: harmonize version list style in YAML comments
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]>
1 parent b3f15b7 commit 28c94ca

13 files changed

+77
-31
lines changed

doc/api/assert.md

+33-11
Original file line numberDiff line numberDiff line change
@@ -318,13 +318,19 @@ changes:
318318
- version: v8.0.0
319319
pr-url: https://github.com/nodejs/node/pull/12142
320320
description: The `Set` and `Map` content is also compared
321-
- version: v6.4.0, v4.7.1
321+
- version:
322+
- v6.4.0
323+
- v4.7.1
322324
pr-url: https://github.com/nodejs/node/pull/8002
323325
description: Typed array slices are handled correctly now.
324-
- version: v6.1.0, v4.5.0
326+
- version:
327+
- v6.1.0
328+
- v4.5.0
325329
pr-url: https://github.com/nodejs/node/pull/6432
326330
description: Objects with circular references can be used as inputs now.
327-
- version: v5.10.1, v4.4.3
331+
- version:
332+
- v5.10.1
333+
- v4.4.3
328334
pr-url: https://github.com/nodejs/node/pull/5910
329335
description: Handle non-`Uint8Array` typed arrays correctly.
330336
-->
@@ -438,13 +444,17 @@ changes:
438444
- version: v8.0.0
439445
pr-url: https://github.com/nodejs/node/pull/12142
440446
description: The `Set` and `Map` content is also compared
441-
- version: v6.4.0, v4.7.1
447+
- version:
448+
- v6.4.0
449+
- v4.7.1
442450
pr-url: https://github.com/nodejs/node/pull/8002
443451
description: Typed array slices are handled correctly now.
444452
- version: v6.1.0
445453
pr-url: https://github.com/nodejs/node/pull/6432
446454
description: Objects with circular references can be used as inputs now.
447-
- version: v5.10.1, v4.4.3
455+
- version:
456+
- v5.10.1
457+
- v4.4.3
448458
pr-url: https://github.com/nodejs/node/pull/5910
449459
description: Handle non-`Uint8Array` typed arrays correctly.
450460
-->
@@ -666,7 +676,9 @@ assert.doesNotReject(Promise.reject(new TypeError('Wrong value')))
666676
<!-- YAML
667677
added: v0.1.21
668678
changes:
669-
- version: v5.11.0, v4.4.5
679+
- version:
680+
- v5.11.0
681+
- v4.4.5
670682
pr-url: https://github.com/nodejs/node/pull/2407
671683
description: The `message` parameter is respected now.
672684
- version: v4.2.0
@@ -975,13 +987,19 @@ changes:
975987
- version: v8.0.0
976988
pr-url: https://github.com/nodejs/node/pull/12142
977989
description: The `Set` and `Map` content is also compared
978-
- version: v6.4.0, v4.7.1
990+
- version:
991+
- v6.4.0
992+
- v4.7.1
979993
pr-url: https://github.com/nodejs/node/pull/8002
980994
description: Typed array slices are handled correctly now.
981-
- version: v6.1.0, v4.5.0
995+
- version:
996+
- v6.1.0
997+
- v4.5.0
982998
pr-url: https://github.com/nodejs/node/pull/6432
983999
description: Objects with circular references can be used as inputs now.
984-
- version: v5.10.1, v4.4.3
1000+
- version:
1001+
- v5.10.1
1002+
- v4.4.3
9851003
pr-url: https://github.com/nodejs/node/pull/5910
9861004
description: Handle non-`Uint8Array` typed arrays correctly.
9871005
-->
@@ -1057,13 +1075,17 @@ changes:
10571075
- version: v8.0.0
10581076
pr-url: https://github.com/nodejs/node/pull/12142
10591077
description: The `Set` and `Map` content is also compared
1060-
- version: v6.4.0, v4.7.1
1078+
- version:
1079+
- v6.4.0
1080+
- v4.7.1
10611081
pr-url: https://github.com/nodejs/node/pull/8002
10621082
description: Typed array slices are handled correctly now.
10631083
- version: v6.1.0
10641084
pr-url: https://github.com/nodejs/node/pull/6432
10651085
description: Objects with circular references can be used as inputs now.
1066-
- version: v5.10.1, v4.4.3
1086+
- version:
1087+
- v5.10.1
1088+
- v4.4.3
10671089
pr-url: https://github.com/nodejs/node/pull/5910
10681090
description: Handle non-`Uint8Array` typed arrays correctly.
10691091
-->

doc/api/buffer.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -1128,7 +1128,9 @@ changes:
11281128
- version: v8.0.0
11291129
pr-url: https://github.com/nodejs/node/pull/10236
11301130
description: The `value` can now be a `Uint8Array`.
1131-
- version: v5.7.0, v4.4.0
1131+
- version:
1132+
- v5.7.0
1133+
- v4.4.0
11321134
pr-url: https://github.com/nodejs/node/pull/4803
11331135
description: When `encoding` is being passed, the `byteOffset` parameter
11341136
is no longer required.
@@ -1985,7 +1987,9 @@ console.log(buf.subarray(-5, -2).toString());
19851987
<!-- YAML
19861988
added: v0.3.0
19871989
changes:
1988-
- version: v7.1.0, v6.9.2
1990+
- version:
1991+
- v7.1.0
1992+
- v6.9.2
19891993
pr-url: https://github.com/nodejs/node/pull/9341
19901994
description: Coercing the offsets to integers now handles values outside
19911995
the 32-bit integer range properly.

doc/api/child_process.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -729,7 +729,9 @@ changes:
729729
- version: v8.0.0
730730
pr-url: https://github.com/nodejs/node/pull/10653
731731
description: The `input` option can now be a `Uint8Array`.
732-
- version: v6.2.1, v4.5.0
732+
- version:
733+
- v6.2.1
734+
- v4.5.0
733735
pr-url: https://github.com/nodejs/node/pull/6939
734736
description: The `encoding` option can now explicitly be set to `buffer`.
735737
-->
@@ -856,7 +858,9 @@ changes:
856858
- version: v8.0.0
857859
pr-url: https://github.com/nodejs/node/pull/10653
858860
description: The `input` option can now be a `Uint8Array`.
859-
- version: v6.2.1, v4.5.0
861+
- version:
862+
- v6.2.1
863+
- v4.5.0
860864
pr-url: https://github.com/nodejs/node/pull/6939
861865
description: The `encoding` option can now explicitly be set to `buffer`.
862866
- version: v5.7.0

doc/api/events.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -291,7 +291,9 @@ myEmitter.emit('event');
291291
<!-- YAML
292292
added: v0.9.3
293293
changes:
294-
- version: v6.1.0, v4.7.0
294+
- version:
295+
- v6.1.0
296+
- v4.7.0
295297
pr-url: https://github.com/nodejs/node/pull/6394
296298
description: For listeners attached using `.once()`, the `listener` argument
297299
now yields the original listener function.

doc/api/http.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -1792,7 +1792,9 @@ changes:
17921792
pr-url: https://github.com/nodejs/node/pull/25974
17931793
description: Return `this` from `writeHead()` to allow chaining with
17941794
`end()`.
1795-
- version: v5.11.0, v4.4.5
1795+
- version:
1796+
- v5.11.0
1797+
- v4.4.5
17961798
pr-url: https://github.com/nodejs/node/pull/6291
17971799
description: A `RangeError` is thrown if `statusCode` is not a number in
17981800
the range `[100, 999]`.
@@ -2182,7 +2184,9 @@ changes:
21822184
- version: v13.3.0
21832185
pr-url: https://github.com/nodejs/node/pull/30570
21842186
description: The `maxHeaderSize` option is supported now.
2185-
- version: v9.6.0, v8.12.0
2187+
- version:
2188+
- v9.6.0
2189+
- v8.12.0
21862190
pr-url: https://github.com/nodejs/node/pull/15752
21872191
description: The `options` argument is supported now.
21882192
-->

doc/api/modules.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -903,8 +903,8 @@ loading.
903903
<!-- YAML
904904
added: v0.1.16
905905
deprecated:
906-
- v12.19.0
907906
- v14.6.0
907+
- v12.19.0
908908
-->
909909

910910
> Stability: 0 - Deprecated: Please use [`require.main`][] and

doc/api/n-api.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5569,8 +5569,8 @@ a specific `napi_env`.
55695569
### napi_get_uv_event_loop
55705570
<!-- YAML
55715571
added:
5572-
- v8.10.0
55735572
- v9.3.0
5573+
- v8.10.0
55745574
napiVersion: 2
55755575
-->
55765576

doc/api/packages.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -800,12 +800,12 @@ The following fields in `package.json` files are used in Node.js:
800800
### `"name"`
801801
<!-- YAML
802802
added:
803-
- v12.16.0
804803
- v13.1.0
804+
- v12.16.0
805805
changes:
806806
- version:
807-
- v12.16.0
808807
- v13.6.0
808+
- v12.16.0
809809
pr-url: https://github.com/nodejs/node/pull/31002
810810
description: Remove the `--experimental-resolve-self` option.
811811
-->
@@ -830,8 +830,8 @@ The `"name"` field can be used in addition to the [`"exports"`][] field to
830830
added: v12.0.0
831831
changes:
832832
- version:
833-
- v12.17.0
834833
- v13.2.0
834+
- v12.17.0
835835
pr-url: https://github.com/nodejs/node/pull/29866
836836
description: Unflag `--experimental-modules`.
837837
-->
@@ -882,18 +882,18 @@ as ES modules and `.cjs` files are always treated as CommonJS.
882882
added: v12.7.0
883883
changes:
884884
- version:
885-
- v12.16.0
886885
- v13.2.0
886+
- v12.16.0
887887
pr-url: https://github.com/nodejs/node/pull/29978
888888
description: Implement conditional exports.
889889
- version:
890-
- v12.16.0
891890
- v13.7.0
891+
- v12.16.0
892892
pr-url: https://github.com/nodejs/node/pull/31001
893893
description: Remove the `--experimental-conditional-exports` option.
894894
- version:
895-
- v12.16.0
896895
- v13.7.0
896+
- v12.16.0
897897
pr-url: https://github.com/nodejs/node/pull/31008
898898
description: Implement logical conditional exports ordering.
899899
- version:

doc/api/process.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -2428,7 +2428,9 @@ flag's behavior.
24282428
<!-- YAML
24292429
added: v0.1.19
24302430
changes:
2431-
- version: v14.0.0
2431+
- version:
2432+
- v14.0.0
2433+
- v12.19.0
24322434
pr-url: https://github.com/nodejs/node/pull/32499
24332435
description: Calling `process.umask()` with no arguments is deprecated.
24342436

doc/api/querystring.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,9 @@ changes:
5555
- version: v6.0.0
5656
pr-url: https://github.com/nodejs/node/pull/6055
5757
description: The returned object no longer inherits from `Object.prototype`.
58-
- version: v6.0.0, v4.2.4
58+
- version:
59+
- v6.0.0
60+
- v4.2.4
5961
pr-url: https://github.com/nodejs/node/pull/3807
6062
description: The `eq` parameter may now have a length of more than `1`.
6163
-->

doc/api/readline.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -471,7 +471,9 @@ changes:
471471
- version: v13.9.0
472472
pr-url: https://github.com/nodejs/node/pull/31318
473473
description: The `tabSize` option is supported now.
474-
- version: v8.3.0, 6.11.4
474+
- version:
475+
- v8.3.0
476+
- v6.11.4
475477
pr-url: https://github.com/nodejs/node/pull/13497
476478
description: Remove max limit of `crlfDelay` option.
477479
- version: v6.6.0

doc/api/tls.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1382,7 +1382,9 @@ changes:
13821382
pr-url: https://github.com/nodejs/node/pull/11984
13831383
description: The `ALPNProtocols` option can be a `TypedArray` or
13841384
`DataView` now.
1385-
- version: v5.3.0, v4.7.0
1385+
- version:
1386+
- v5.3.0
1387+
- v4.7.0
13861388
pr-url: https://github.com/nodejs/node/pull/4246
13871389
description: The `secureContext` option is supported now.
13881390
- version: v5.0.0

doc/api/url.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1268,7 +1268,9 @@ changes:
12681268
pr-url: https://github.com/nodejs/node/pull/8215
12691269
description: The `auth` fields are now kept intact when `from` and `to`
12701270
refer to the same host.
1271-
- version: v6.5.0, v4.6.2
1271+
- version:
1272+
- v6.5.0
1273+
- v4.6.2
12721274
pr-url: https://github.com/nodejs/node/pull/8214
12731275
description: The `port` field is copied correctly now.
12741276
- version: v6.0.0

0 commit comments

Comments
 (0)