Skip to content

Commit 9288f9d

Browse files
aduh95MylesBorins
authored andcommitted
doc: harmonize YAML comments
Refs: nodejs/remark-preset-lint-node#139 PR-URL: #35575 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Ben Coe <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: James M Snell <[email protected]>
1 parent 16f8298 commit 9288f9d

File tree

6 files changed

+27
-8
lines changed

6 files changed

+27
-8
lines changed

doc/api/buffer.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -2756,7 +2756,9 @@ console.log(buf);
27562756
<!-- YAML
27572757
added: v0.5.5
27582758
changes:
2759-
- version: v14.9.0
2759+
- version:
2760+
- v14.9.0
2761+
- v12.19.0
27602762
pr-url: https://github.com/nodejs/node/pull/34729
27612763
description: This function is also available as `buf.writeUint16LE()`.
27622764
- version: v10.0.0

doc/api/deprecations.md

+10-3
Original file line numberDiff line numberDiff line change
@@ -722,7 +722,7 @@ changes:
722722
pr-url: https://github.com/nodejs/node/pull/10116
723723
description: A deprecation code has been assigned.
724724
- version: v1.0.0
725-
pr-url: https://github.com/iojs/io.js/pull/166
725+
pr-url: https://github.com/nodejs/node/pull/166
726726
description: Documentation-only deprecation.
727727
-->
728728

@@ -2121,6 +2121,9 @@ The `crypto._toBuf()` function was not designed to be used by modules outside
21212121
of Node.js core and was removed.
21222122

21232123
### DEP0115: `crypto.prng()`, `crypto.pseudoRandomBytes()`, `crypto.rng()`
2124+
2125+
<!--lint disable nodejs-yaml-comments -->
2126+
21242127
<!-- YAML
21252128
changes:
21262129
- version: v11.0.0
@@ -2131,6 +2134,8 @@ changes:
21312134
with `--pending-deprecation` support.
21322135
-->
21332136

2137+
<!--lint enable nodejs-yaml-comments -->
2138+
21342139
Type: Documentation-only (supports [`--pending-deprecation`][])
21352140

21362141
In recent versions of Node.js, there is no difference between
@@ -2505,7 +2510,9 @@ purpose and is only available on CommonJS environment.
25052510
### DEP0139: `process.umask()` with no arguments
25062511
<!-- YAML
25072512
changes:
2508-
- version: v14.0.0
2513+
- version:
2514+
- v14.0.0
2515+
- v12.19.0
25092516
pr-url: https://github.com/nodejs/node/pull/32499
25102517
description: Documentation-only deprecation.
25112518
-->
@@ -2631,7 +2638,7 @@ The [`crypto.Certificate()` constructor][] is deprecated. Use
26312638
### DEP0XXX: `fs.rmdir(path, { recursive: true })`
26322639
<!-- YAML
26332640
changes:
2634-
- version: REPLACME
2641+
- version: REPLACEME
26352642
pr-url: https://github.com/nodejs/node/pull/35579
26362643
description: Documentation-only deprecation.
26372644
-->

doc/api/errors.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -2208,7 +2208,8 @@ changes:
22082208
- version:
22092209
- v11.4.0
22102210
- v10.15.0
2211-
pr-url: https://github.com/nodejs/node/commit/186035243fad247e3955f
2211+
commit: 186035243fad247e3955f
2212+
pr-url: https://github.com/nodejs-private/node-private/pull/143
22122213
description: Max header size in `http_parser` was set to 8KB.
22132214
-->
22142215

doc/api/http.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1182,7 +1182,7 @@ per connection (in the case of HTTP Keep-Alive connections).
11821182
added: v0.1.94
11831183
changes:
11841184
- version: v10.0.0
1185-
pr-url: v10.0.0
1185+
pr-url: https://github.com/nodejs/node/pull/19981
11861186
description: Not listening to this event no longer causes the socket
11871187
to be destroyed if a client sends an Upgrade header.
11881188
-->

doc/api/http2.md

+9
Original file line numberDiff line numberDiff line change
@@ -2054,6 +2054,9 @@ added: v8.4.0
20542054
changes:
20552055
- version:
20562056
- v14.4.0
2057+
- v12.18.0
2058+
- v10.21.0
2059+
commit: 3948830ce6408be620b09a70bf66158623022af0
20572060
pr-url: https://github.com/nodejs-private/node-private/pull/204
20582061
description: Added `maxSettings` option with a default of 32.
20592062
- version:
@@ -2193,6 +2196,9 @@ added: v8.4.0
21932196
changes:
21942197
- version:
21952198
- v14.4.0
2199+
- v12.18.0
2200+
- v10.21.0
2201+
commit: 3948830ce6408be620b09a70bf66158623022af0
21962202
pr-url: https://github.com/nodejs-private/node-private/pull/204
21972203
description: Added `maxSettings` option with a default of 32.
21982204
- version:
@@ -2319,6 +2325,9 @@ added: v8.4.0
23192325
changes:
23202326
- version:
23212327
- v14.4.0
2328+
- v12.18.0
2329+
- v10.21.0
2330+
commit: 3948830ce6408be620b09a70bf66158623022af0
23222331
pr-url: https://github.com/nodejs-private/node-private/pull/204
23232332
description: Added `maxSettings` option with a default of 32.
23242333
- version: v13.0.0

doc/api/util.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1180,7 +1180,7 @@ is not supported.
11801180
added: v8.3.0
11811181
changes:
11821182
- version: v11.0.0
1183-
pr-url: v11.0.0
1183+
pr-url: https://github.com/nodejs/node/pull/22281
11841184
description: The class is now available on the global object.
11851185
-->
11861186

@@ -1241,7 +1241,7 @@ mark.
12411241
added: v8.3.0
12421242
changes:
12431243
- version: v11.0.0
1244-
pr-url: v11.0.0
1244+
pr-url: https://github.com/nodejs/node/pull/22281
12451245
description: The class is now available on the global object.
12461246
-->
12471247

0 commit comments

Comments
 (0)