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-01 21:35:23 +0300
committerMyles Borins <mylesborins@github.com>2020-10-14 23:21:21 +0300
commit8cacca0f62e18fada33efb1c3559591021ed5e17 (patch)
treed8cb6a9360ff4638cc896cbd7145f66e8f987be4 /doc
parentb7305284e28d5bdef15cf1c3de26248b63ad7f52 (diff)
doc: changes description must end with a period
Refs: https://github.com/nodejs/remark-preset-lint-node/pull/139 PR-URL: https://github.com/nodejs/node/pull/35454 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ujjwal Sharma <ryzokuken@disroot.org> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Khaidi Chu <i@2333.moe> Reviewed-By: Michael Dawson <midawson@redhat.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/api/assert.md20
-rw-r--r--doc/api/async_hooks.md2
-rw-r--r--doc/api/cli.md14
-rw-r--r--doc/api/crypto.md8
-rw-r--r--doc/api/fs.md10
-rw-r--r--doc/api/n-api.md11
-rw-r--r--doc/api/os.md2
-rw-r--r--doc/api/vm.md5
8 files changed, 36 insertions, 36 deletions
diff --git a/doc/api/assert.md b/doc/api/assert.md
index 58e41723ee4..1fd57b6f9f9 100644
--- a/doc/api/assert.md
+++ b/doc/api/assert.md
@@ -314,10 +314,10 @@ changes:
minor comparison adjustments to make the check less surprising.
- version: v9.0.0
pr-url: https://github.com/nodejs/node/pull/15001
- description: The `Error` names and messages are now properly compared
+ description: The `Error` names and messages are now properly compared.
- version: v8.0.0
pr-url: https://github.com/nodejs/node/pull/12142
- description: The `Set` and `Map` content is also compared
+ description: The `Set` and `Map` content is also compared.
- version:
- v6.4.0
- v4.7.1
@@ -440,10 +440,10 @@ changes:
comparison.
- version: v8.5.0
pr-url: https://github.com/nodejs/node/pull/15001
- description: The `Error` names and messages are now properly compared
+ description: The `Error` names and messages are now properly compared.
- version: v8.0.0
pr-url: https://github.com/nodejs/node/pull/12142
- description: The `Set` and `Map` content is also compared
+ description: The `Set` and `Map` content is also compared.
- version:
- v6.4.0
- v4.7.1
@@ -983,10 +983,10 @@ changes:
NaN.
- version: v9.0.0
pr-url: https://github.com/nodejs/node/pull/15001
- description: The `Error` names and messages are now properly compared
+ description: The `Error` names and messages are now properly compared.
- version: v8.0.0
pr-url: https://github.com/nodejs/node/pull/12142
- description: The `Set` and `Map` content is also compared
+ description: The `Set` and `Map` content is also compared.
- version:
- v6.4.0
- v4.7.1
@@ -1071,10 +1071,10 @@ changes:
comparison.
- version: v9.0.0
pr-url: https://github.com/nodejs/node/pull/15001
- description: The `Error` names and messages are now properly compared
+ description: The `Error` names and messages are now properly compared.
- version: v8.0.0
pr-url: https://github.com/nodejs/node/pull/12142
- description: The `Set` and `Map` content is also compared
+ description: The `Set` and `Map` content is also compared.
- version:
- v6.4.0
- v4.7.1
@@ -1160,7 +1160,7 @@ added: v0.1.21
changes:
- version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/17003
- description: Used comparison changed from Strict Equality to `Object.is()`
+ description: Used comparison changed from Strict Equality to `Object.is()`.
-->
* `actual` {any}
@@ -1339,7 +1339,7 @@ added: v0.1.21
changes:
- version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/17003
- description: Used comparison changed from Strict Equality to `Object.is()`
+ description: Used comparison changed from Strict Equality to `Object.is()`.
-->
* `actual` {any}
diff --git a/doc/api/async_hooks.md b/doc/api/async_hooks.md
index 0a8b8d1c520..cf3fd79ffaf 100644
--- a/doc/api/async_hooks.md
+++ b/doc/api/async_hooks.md
@@ -544,7 +544,7 @@ added: v8.1.0
changes:
- version: v8.2.0
pr-url: https://github.com/nodejs/node/pull/13490
- description: Renamed from `currentId`
+ description: Renamed from `currentId`.
-->
* Returns: {number} The `asyncId` of the current execution context. Useful to
diff --git a/doc/api/cli.md b/doc/api/cli.md
index a5c678b30cb..0112319a3a3 100644
--- a/doc/api/cli.md
+++ b/doc/api/cli.md
@@ -274,7 +274,7 @@ changes:
- version: v13.6.0
pr-url: https://github.com/nodejs/node/pull/30980
description: changed from `--experimental-wasi-unstable-preview0` to
- `--experimental-wasi-unstable-preview1`
+ `--experimental-wasi-unstable-preview1`.
-->
Enable experimental WebAssembly System Interface (WASI) support.
@@ -674,7 +674,7 @@ changes:
- version: v12.0.0
pr-url: https://github.com/nodejs/node/pull/27312
description: Changed from `--diagnostic-report-directory` to
- `--report-directory`
+ `--report-directory`.
-->
Location at which the report will be generated.
@@ -689,7 +689,7 @@ changes:
- version: v12.0.0
pr-url: https://github.com/nodejs/node/pull/27312
description: changed from `--diagnostic-report-filename` to
- `--report-filename`
+ `--report-filename`.
-->
Name of the file to which the report will be written.
@@ -704,7 +704,7 @@ changes:
- version: v12.0.0
pr-url: https://github.com/nodejs/node/pull/27312
description: changed from `--diagnostic-report-on-fatalerror` to
- `--report-on-fatalerror`
+ `--report-on-fatalerror`.
-->
Enables the report to be triggered on fatal errors (internal errors within
@@ -723,7 +723,7 @@ changes:
- version: v12.0.0
pr-url: https://github.com/nodejs/node/pull/27312
description: changed from `--diagnostic-report-on-signal` to
- `--report-on-signal`
+ `--report-on-signal`.
-->
Enables report to be generated upon receiving the specified (or predefined)
@@ -740,7 +740,7 @@ changes:
- version: v12.0.0
pr-url: https://github.com/nodejs/node/pull/27312
description: changed from `--diagnostic-report-signal` to
- `--report-signal`
+ `--report-signal`.
-->
Sets or resets the signal for report generation (not supported on Windows).
@@ -756,7 +756,7 @@ changes:
- version: v12.0.0
pr-url: https://github.com/nodejs/node/pull/27312
description: changed from `--diagnostic-report-uncaught-exception` to
- `--report-uncaught-exception`
+ `--report-uncaught-exception`.
-->
Enables report to be generated on uncaught exceptions. Useful when inspecting
diff --git a/doc/api/crypto.md b/doc/api/crypto.md
index b6bd41b9fdf..6021cb8d5a3 100644
--- a/doc/api/crypto.md
+++ b/doc/api/crypto.md
@@ -842,11 +842,11 @@ added: v0.11.14
changes:
- version: v6.0.0
pr-url: https://github.com/nodejs/node/pull/5522
- description: The default `inputEncoding` changed from `binary` to `utf8`
+ description: The default `inputEncoding` changed from `binary` to `utf8`.
- version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/16849
description: Changed error format to better support invalid public key
- error
+ error.
-->
* `otherPublicKey` {string | Buffer | TypedArray | DataView}
@@ -1249,14 +1249,14 @@ changes:
description: Added support for `'dh'`.
- version: v12.0.0
pr-url: https://github.com/nodejs/node/pull/26960
- description: Added support for `'rsa-pss'`
+ description: Added support for `'rsa-pss'`.
- version: v12.0.0
pr-url: https://github.com/nodejs/node/pull/26786
description: This property now returns `undefined` for KeyObject
instances of unrecognized type instead of aborting.
- version: v12.0.0
pr-url: https://github.com/nodejs/node/pull/26774
- description: Added support for `'x25519'` and `'x448'`
+ description: Added support for `'x25519'` and `'x448'`.
- version: v12.0.0
pr-url: https://github.com/nodejs/node/pull/26319
description: Added support for `'ed25519'` and `'ed448'`.
diff --git a/doc/api/fs.md b/doc/api/fs.md
index db3e41e1ee1..58b97be26c2 100644
--- a/doc/api/fs.md
+++ b/doc/api/fs.md
@@ -2922,7 +2922,7 @@ changes:
- version: v13.11.0
pr-url: https://github.com/nodejs/node/pull/31402
description: Options object can be passed in
- to make Buffer, offset, length and position optional
+ to make Buffer, offset, length and position optional.
-->
* `fd` {integer}
* `options` {Object}
@@ -3220,7 +3220,7 @@ changes:
- version: v14.0.0
pr-url: https://github.com/nodejs/node/pull/32460
description: Options object can be passed in
- to make offset, length and position optional
+ to make offset, length and position optional.
-->
* `fd` {integer}
@@ -3775,7 +3775,7 @@ changes:
- version: v12.0.0
pr-url: https://github.com/nodejs/node/pull/23724
description: If the `type` argument is left undefined, Node will autodetect
- `target` type and automatically select `dir` or `file`
+ `target` type and automatically select `dir` or `file`.
-->
* `target` {string|Buffer|URL}
@@ -3823,7 +3823,7 @@ changes:
- version: v12.0.0
pr-url: https://github.com/nodejs/node/pull/23724
description: If the `type` argument is left undefined, Node will autodetect
- `target` type and automatically select `dir` or `file`
+ `target` type and automatically select `dir` or `file`.
-->
* `target` {string|Buffer|URL}
@@ -4216,7 +4216,7 @@ changes:
- version: v10.10.0
pr-url: https://github.com/nodejs/node/pull/22150
description: The `buffer` parameter can now be any `TypedArray` or a
- `DataView`
+ `DataView`.
- version: v10.0.0
pr-url: https://github.com/nodejs/node/pull/12562
description: The `callback` parameter is no longer optional. Not passing
diff --git a/doc/api/n-api.md b/doc/api/n-api.md
index f332a37836f..1f1ecf43d4b 100644
--- a/doc/api/n-api.md
+++ b/doc/api/n-api.md
@@ -3747,7 +3747,7 @@ if (status != napi_ok) return status;
changes:
- version: v14.12.0
pr-url: https://github.com/nodejs/node/pull/35214
- description: added `napi_default_method` and `napi_default_property`
+ description: added `napi_default_method` and `napi_default_property`.
-->
```c
@@ -5784,13 +5784,12 @@ napiVersion: 4
changes:
- version: v14.5.0
pr-url: https://github.com/nodejs/node/pull/33453
- description: >
- Support for `napi_would_deadlock` has been reverted.
+ description: Support for `napi_would_deadlock` has been reverted.
- version: v14.1.0
pr-url: https://github.com/nodejs/node/pull/32689
- description: >
- Return `napi_would_deadlock` when called with `napi_tsfn_blocking` from
- the main thread or a worker thread and the queue is full.
+ description: Return `napi_would_deadlock` when called with
+ `napi_tsfn_blocking` from the main thread or a worker thread
+ and the queue is full.
-->
```c
diff --git a/doc/api/os.md b/doc/api/os.md
index 239255147d4..1053dd37626 100644
--- a/doc/api/os.md
+++ b/doc/api/os.md
@@ -324,7 +324,7 @@ changes:
- version: v2.0.0
pr-url: https://github.com/nodejs/node/pull/747
description: This function is now cross-platform consistent and no longer
- returns a path with a trailing slash on any platform
+ returns a path with a trailing slash on any platform.
-->
* Returns: {string}
diff --git a/doc/api/vm.md b/doc/api/vm.md
index 34e1b2d2f00..d6035e6b4fb 100644
--- a/doc/api/vm.md
+++ b/doc/api/vm.md
@@ -61,7 +61,7 @@ changes:
- version: v10.6.0
pr-url: https://github.com/nodejs/node/pull/20300
description: The `produceCachedData` is deprecated in favour of
- `script.createCachedData()`
+ `script.createCachedData()`.
-->
* `code` {string} The JavaScript code to compile.
@@ -816,7 +816,8 @@ changes:
description: The `importModuleDynamically` option is now supported.
- version: v14.3.0
pr-url: https://github.com/nodejs/node/pull/33364
- description: Removal of `importModuleDynamically` due to compatibility issues
+ description: Removal of `importModuleDynamically` due to compatibility
+ issues.
-->
* `code` {string} The body of the function to compile.