Skip to content

Commit

Permalink
doc: harmonize YAML comments
Browse files Browse the repository at this point in the history
Refs: nodejs/remark-preset-lint-node#139

PR-URL: #35575
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Ben Coe <bencoe@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
  • Loading branch information
aduh95 authored and MylesBorins committed Oct 14, 2020
1 parent 16f8298 commit 9288f9d
Show file tree
Hide file tree
Showing 6 changed files with 27 additions and 8 deletions.
4 changes: 3 additions & 1 deletion doc/api/buffer.md
Expand Up @@ -2756,7 +2756,9 @@ console.log(buf);
<!-- YAML
added: v0.5.5
changes:
- version: v14.9.0
- version:
- v14.9.0
- v12.19.0
pr-url: https://github.com/nodejs/node/pull/34729
description: This function is also available as `buf.writeUint16LE()`.
- version: v10.0.0
Expand Down
13 changes: 10 additions & 3 deletions doc/api/deprecations.md
Expand Up @@ -722,7 +722,7 @@ changes:
pr-url: https://github.com/nodejs/node/pull/10116
description: A deprecation code has been assigned.
- version: v1.0.0
pr-url: https://github.com/iojs/io.js/pull/166
pr-url: https://github.com/nodejs/node/pull/166
description: Documentation-only deprecation.
-->

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

### DEP0115: `crypto.prng()`, `crypto.pseudoRandomBytes()`, `crypto.rng()`

<!--lint disable nodejs-yaml-comments -->

<!-- YAML
changes:
- version: v11.0.0
Expand All @@ -2131,6 +2134,8 @@ changes:
with `--pending-deprecation` support.
-->

<!--lint enable nodejs-yaml-comments -->

Type: Documentation-only (supports [`--pending-deprecation`][])

In recent versions of Node.js, there is no difference between
Expand Down Expand Up @@ -2505,7 +2510,9 @@ purpose and is only available on CommonJS environment.
### DEP0139: `process.umask()` with no arguments
<!-- YAML
changes:
- version: v14.0.0
- version:
- v14.0.0
- v12.19.0
pr-url: https://github.com/nodejs/node/pull/32499
description: Documentation-only deprecation.
-->
Expand Down Expand Up @@ -2631,7 +2638,7 @@ The [`crypto.Certificate()` constructor][] is deprecated. Use
### DEP0XXX: `fs.rmdir(path, { recursive: true })`
<!-- YAML
changes:
- version: REPLACME
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/35579
description: Documentation-only deprecation.
-->
Expand Down
3 changes: 2 additions & 1 deletion doc/api/errors.md
Expand Up @@ -2208,7 +2208,8 @@ changes:
- version:
- v11.4.0
- v10.15.0
pr-url: https://github.com/nodejs/node/commit/186035243fad247e3955f
commit: 186035243fad247e3955f
pr-url: https://github.com/nodejs-private/node-private/pull/143
description: Max header size in `http_parser` was set to 8KB.
-->

Expand Down
2 changes: 1 addition & 1 deletion doc/api/http.md
Expand Up @@ -1182,7 +1182,7 @@ per connection (in the case of HTTP Keep-Alive connections).
added: v0.1.94
changes:
- version: v10.0.0
pr-url: v10.0.0
pr-url: https://github.com/nodejs/node/pull/19981
description: Not listening to this event no longer causes the socket
to be destroyed if a client sends an Upgrade header.
-->
Expand Down
9 changes: 9 additions & 0 deletions doc/api/http2.md
Expand Up @@ -2054,6 +2054,9 @@ added: v8.4.0
changes:
- version:
- v14.4.0
- v12.18.0
- v10.21.0
commit: 3948830ce6408be620b09a70bf66158623022af0
pr-url: https://github.com/nodejs-private/node-private/pull/204
description: Added `maxSettings` option with a default of 32.
- version:
Expand Down Expand Up @@ -2193,6 +2196,9 @@ added: v8.4.0
changes:
- version:
- v14.4.0
- v12.18.0
- v10.21.0
commit: 3948830ce6408be620b09a70bf66158623022af0
pr-url: https://github.com/nodejs-private/node-private/pull/204
description: Added `maxSettings` option with a default of 32.
- version:
Expand Down Expand Up @@ -2319,6 +2325,9 @@ added: v8.4.0
changes:
- version:
- v14.4.0
- v12.18.0
- v10.21.0
commit: 3948830ce6408be620b09a70bf66158623022af0
pr-url: https://github.com/nodejs-private/node-private/pull/204
description: Added `maxSettings` option with a default of 32.
- version: v13.0.0
Expand Down
4 changes: 2 additions & 2 deletions doc/api/util.md
Expand Up @@ -1180,7 +1180,7 @@ is not supported.
added: v8.3.0
changes:
- version: v11.0.0
pr-url: v11.0.0
pr-url: https://github.com/nodejs/node/pull/22281
description: The class is now available on the global object.
-->

Expand Down Expand Up @@ -1241,7 +1241,7 @@ mark.
added: v8.3.0
changes:
- version: v11.0.0
pr-url: v11.0.0
pr-url: https://github.com/nodejs/node/pull/22281
description: The class is now available on the global object.
-->

Expand Down

0 comments on commit 9288f9d

Please sign in to comment.