Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/nodejs/node.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorAntoine du Hamel <duhamelantoine1995@gmail.com>2020-10-09 22:08:06 +0300
committerMyles Borins <mylesborins@github.com>2020-10-14 23:21:27 +0300
commit9288f9d74bd1ba56196adffee4fd1861b2b4ebe0 (patch)
treee3a03f10a45456675b9a15d0e052d9f4e466f515 /doc
parent16f8298170245f81f91ea14af3a98fa7f2b22a10 (diff)
doc: harmonize YAML comments
Refs: https://github.com/nodejs/remark-preset-lint-node/pull/139 PR-URL: https://github.com/nodejs/node/pull/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>
Diffstat (limited to 'doc')
-rw-r--r--doc/api/buffer.md4
-rw-r--r--doc/api/deprecations.md13
-rw-r--r--doc/api/errors.md3
-rw-r--r--doc/api/http.md2
-rw-r--r--doc/api/http2.md9
-rw-r--r--doc/api/util.md4
6 files changed, 27 insertions, 8 deletions
diff --git a/doc/api/buffer.md b/doc/api/buffer.md
index 118ebf86e77..015f87a169c 100644
--- a/doc/api/buffer.md
+++ b/doc/api/buffer.md
@@ -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
diff --git a/doc/api/deprecations.md b/doc/api/deprecations.md
index 1f16a9a5756..64b8ca6a8dd 100644
--- a/doc/api/deprecations.md
+++ b/doc/api/deprecations.md
@@ -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.
-->
@@ -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
@@ -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
@@ -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.
-->
@@ -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.
-->
diff --git a/doc/api/errors.md b/doc/api/errors.md
index 79a5ac279de..4c963210ad9 100644
--- a/doc/api/errors.md
+++ b/doc/api/errors.md
@@ -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.
-->
diff --git a/doc/api/http.md b/doc/api/http.md
index e84b0bb67f1..552ffe4670f 100644
--- a/doc/api/http.md
+++ b/doc/api/http.md
@@ -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.
-->
diff --git a/doc/api/http2.md b/doc/api/http2.md
index 9679ed23f69..133cb564f6e 100644
--- a/doc/api/http2.md
+++ b/doc/api/http2.md
@@ -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:
@@ -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:
@@ -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
diff --git a/doc/api/util.md b/doc/api/util.md
index c36636db489..f50ef6b3b2a 100644
--- a/doc/api/util.md
+++ b/doc/api/util.md
@@ -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.
-->
@@ -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.
-->