Skip to content

Commit 0aa2c5b

Browse files
committed
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 dcf708d commit 0aa2c5b

File tree

6 files changed

+17
-8
lines changed

6 files changed

+17
-8
lines changed

doc/api/buffer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2795,7 +2795,7 @@ added: v0.5.5
27952795
changes:
27962796
- version:
27972797
- v14.9.0
2798-
- 12.19.0
2798+
- v12.19.0
27992799
pr-url: https://github.com/nodejs/node/pull/34729
28002800
description: This function is also available as `buf.writeUint16LE()`.
28012801
- version: v10.0.0

doc/api/deprecations.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -729,7 +729,7 @@ changes:
729729
pr-url: https://github.com/nodejs/node/pull/10116
730730
description: A deprecation code has been assigned.
731731
- version: v1.0.0
732-
pr-url: https://github.com/iojs/io.js/pull/166
732+
pr-url: https://github.com/nodejs/node/pull/166
733733
description: Documentation-only deprecation.
734734
-->
735735

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

21452145
### DEP0115: `crypto.prng()`, `crypto.pseudoRandomBytes()`, `crypto.rng()`
2146+
2147+
<!--lint disable nodejs-yaml-comments -->
2148+
21462149
<!-- YAML
21472150
changes:
21482151
- version: v11.0.0
@@ -2153,6 +2156,8 @@ changes:
21532156
with `--pending-deprecation` support.
21542157
-->
21552158

2159+
<!--lint enable nodejs-yaml-comments -->
2160+
21562161
Type: Documentation-only (supports [`--pending-deprecation`][])
21572162

21582163
In recent versions of Node.js, there is no difference between
@@ -2531,8 +2536,8 @@ purpose and is only available on CommonJS environment.
25312536
<!-- YAML
25322537
changes:
25332538
- version:
2534-
- v12.19.0
25352539
- v14.0.0
2540+
- v12.19.0
25362541
pr-url: https://github.com/nodejs/node/pull/32499
25372542
description: Documentation-only deprecation.
25382543
-->
@@ -2658,7 +2663,7 @@ The [`crypto.Certificate()` constructor][] is deprecated. Use
26582663
### DEP0XXX: `fs.rmdir(path, { recursive: true })`
26592664
<!-- YAML
26602665
changes:
2661-
- version: REPLACME
2666+
- version: REPLACEME
26622667
pr-url: https://github.com/nodejs/node/pull/35579
26632668
description: Documentation-only deprecation.
26642669
-->

doc/api/errors.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2396,7 +2396,8 @@ changes:
23962396
- version:
23972397
- v11.4.0
23982398
- v10.15.0
2399-
pr-url: https://github.com/nodejs/node/commit/186035243fad247e3955f
2399+
commit: 186035243fad247e3955f
2400+
pr-url: https://github.com/nodejs-private/node-private/pull/143
24002401
description: Max header size in `http_parser` was set to 8KB.
24012402
-->
24022403

doc/api/http.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1193,7 +1193,7 @@ per connection (in the case of HTTP Keep-Alive connections).
11931193
added: v0.1.94
11941194
changes:
11951195
- version: v10.0.0
1196-
pr-url: v10.0.0
1196+
pr-url: https://github.com/nodejs/node/pull/19981
11971197
description: Not listening to this event no longer causes the socket
11981198
to be destroyed if a client sends an Upgrade header.
11991199
-->

doc/api/http2.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2066,6 +2066,7 @@ changes:
20662066
- v14.4.0
20672067
- v12.18.0
20682068
- v10.21.0
2069+
commit: 3948830ce6408be620b09a70bf66158623022af0
20692070
pr-url: https://github.com/nodejs-private/node-private/pull/204
20702071
description: Added `maxSettings` option with a default of 32.
20712072
- version:
@@ -2207,6 +2208,7 @@ changes:
22072208
- v14.4.0
22082209
- v12.18.0
22092210
- v10.21.0
2211+
commit: 3948830ce6408be620b09a70bf66158623022af0
22102212
pr-url: https://github.com/nodejs-private/node-private/pull/204
22112213
description: Added `maxSettings` option with a default of 32.
22122214
- version:
@@ -2335,6 +2337,7 @@ changes:
23352337
- v14.4.0
23362338
- v12.18.0
23372339
- v10.21.0
2340+
commit: 3948830ce6408be620b09a70bf66158623022af0
23382341
pr-url: https://github.com/nodejs-private/node-private/pull/204
23392342
description: Added `maxSettings` option with a default of 32.
23402343
- version: v13.0.0

doc/api/util.md

Lines changed: 2 additions & 2 deletions
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)