doc: changes description must end with a period

Refs: nodejs/remark-preset-lint-node#139 PR-URL: #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>
nodejs · Oct 9, 2020 · 9fedb04 · 9fedb04
1 parent 125523b
commit 9fedb04
Show file tree

Hide file tree

Showing 8 changed files with 39 additions and 39 deletions.
diff --git a/doc/api/assert.md b/doc/api/assert.md
@@ -15,7 +15,7 @@ added: v9.9.0
 changes:
   - version: REPLACEME
     pr-url: https://github.com/nodejs/node/pull/34001
-    description: Exposed as `require('assert/strict')`
+    description: Exposed as `require('assert/strict')`.
   - version:
       - v13.9.0
       - v12.16.2
@@ -330,10 +330,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
@@ -456,10 +456,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
@@ -999,10 +999,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
@@ -1087,10 +1087,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
@@ -1176,7 +1176,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}
@@ -1355,7 +1355,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
@@ -546,7 +546,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
@@ -290,7 +290,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.
@@ -702,7 +702,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.
@@ -719,7 +719,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.
@@ -737,7 +737,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
@@ -758,7 +758,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)
@@ -777,7 +777,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).
@@ -795,7 +795,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
@@ -514,7 +514,7 @@ added: v1.0.0
 changes:
   - version: REPLACEME
     pr-url: https://github.com/nodejs/node/pull/35093
-    decription: The buffer argument can be a string or ArrayBuffer and is
+    description: The buffer argument can be a string or ArrayBuffer and is
                 limited to no more than 2 ** 31 - 1 bytes.
   - version: v7.2.0
     pr-url: https://github.com/nodejs/node/pull/9398
@@ -543,7 +543,7 @@ added: v1.0.0
 changes:
   - version: REPLACEME
     pr-url: https://github.com/nodejs/node/pull/35093
-    decription: The buffer argument can be a string or ArrayBuffer and is
+    description: The buffer argument can be a string or ArrayBuffer and is
                 limited to no more than 2 ** 31 - 1 bytes.
   - version: v11.0.0
     pr-url: https://github.com/nodejs/node/pull/17825
@@ -884,11 +884,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|ArrayBuffer|Buffer|TypedArray|DataView}
@@ -1295,14 +1295,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
@@ -2938,7 +2938,7 @@ changes:
      - v12.17.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}
@@ -3240,7 +3240,7 @@ changes:
      - v12.17.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}
@@ -3799,7 +3799,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}
@@ -3847,7 +3847,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}
@@ -4240,7 +4240,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
@@ -3764,7 +3764,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
@@ -5806,13 +5806,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
@@ -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
@@ -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.
@@ -820,7 +820,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.