Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
aduh95 authored and MylesBorins committed Oct 14, 2020
1 parent b730528 commit 8cacca0
Show file tree
Hide file tree
Showing 8 changed files with 36 additions and 36 deletions.
20 changes: 10 additions & 10 deletions doc/api/assert.md
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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}
Expand Down Expand Up @@ -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}
Expand Down
2 changes: 1 addition & 1 deletion doc/api/async_hooks.md
Expand Up @@ -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
Expand Down
14 changes: 7 additions & 7 deletions doc/api/cli.md
Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand All @@ -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.
Expand All @@ -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
Expand All @@ -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)
Expand All @@ -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).
Expand All @@ -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
Expand Down
8 changes: 4 additions & 4 deletions doc/api/crypto.md
Expand Up @@ -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}
Expand Down Expand Up @@ -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'`.
Expand Down
10 changes: 5 additions & 5 deletions doc/api/fs.md
Expand Up @@ -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}
Expand Down Expand Up @@ -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}
Expand Down Expand Up @@ -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}
Expand Down Expand Up @@ -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}
Expand Down Expand Up @@ -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
Expand Down
11 changes: 5 additions & 6 deletions doc/api/n-api.md
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion doc/api/os.md
Expand Up @@ -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}
Expand Down
5 changes: 3 additions & 2 deletions doc/api/vm.md
Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down

0 comments on commit 8cacca0

Please sign in to comment.