Skip to content

Commit 8cacca0

Browse files
aduh95MylesBorins
authored andcommitted
doc: changes description must end with a period
Refs: nodejs/remark-preset-lint-node#139 PR-URL: #35454 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Ujjwal Sharma <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]> Reviewed-By: Khaidi Chu <[email protected]> Reviewed-By: Michael Dawson <[email protected]>
1 parent b730528 commit 8cacca0

File tree

8 files changed

+36
-36
lines changed

8 files changed

+36
-36
lines changed

doc/api/assert.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -314,10 +314,10 @@ changes:
314314
minor comparison adjustments to make the check less surprising.
315315
- version: v9.0.0
316316
pr-url: https://github.com/nodejs/node/pull/15001
317-
description: The `Error` names and messages are now properly compared
317+
description: The `Error` names and messages are now properly compared.
318318
- version: v8.0.0
319319
pr-url: https://github.com/nodejs/node/pull/12142
320-
description: The `Set` and `Map` content is also compared
320+
description: The `Set` and `Map` content is also compared.
321321
- version:
322322
- v6.4.0
323323
- v4.7.1
@@ -440,10 +440,10 @@ changes:
440440
comparison.
441441
- version: v8.5.0
442442
pr-url: https://github.com/nodejs/node/pull/15001
443-
description: The `Error` names and messages are now properly compared
443+
description: The `Error` names and messages are now properly compared.
444444
- version: v8.0.0
445445
pr-url: https://github.com/nodejs/node/pull/12142
446-
description: The `Set` and `Map` content is also compared
446+
description: The `Set` and `Map` content is also compared.
447447
- version:
448448
- v6.4.0
449449
- v4.7.1
@@ -983,10 +983,10 @@ changes:
983983
NaN.
984984
- version: v9.0.0
985985
pr-url: https://github.com/nodejs/node/pull/15001
986-
description: The `Error` names and messages are now properly compared
986+
description: The `Error` names and messages are now properly compared.
987987
- version: v8.0.0
988988
pr-url: https://github.com/nodejs/node/pull/12142
989-
description: The `Set` and `Map` content is also compared
989+
description: The `Set` and `Map` content is also compared.
990990
- version:
991991
- v6.4.0
992992
- v4.7.1
@@ -1071,10 +1071,10 @@ changes:
10711071
comparison.
10721072
- version: v9.0.0
10731073
pr-url: https://github.com/nodejs/node/pull/15001
1074-
description: The `Error` names and messages are now properly compared
1074+
description: The `Error` names and messages are now properly compared.
10751075
- version: v8.0.0
10761076
pr-url: https://github.com/nodejs/node/pull/12142
1077-
description: The `Set` and `Map` content is also compared
1077+
description: The `Set` and `Map` content is also compared.
10781078
- version:
10791079
- v6.4.0
10801080
- v4.7.1
@@ -1160,7 +1160,7 @@ added: v0.1.21
11601160
changes:
11611161
- version: v10.0.0
11621162
pr-url: https://github.com/nodejs/node/pull/17003
1163-
description: Used comparison changed from Strict Equality to `Object.is()`
1163+
description: Used comparison changed from Strict Equality to `Object.is()`.
11641164
-->
11651165

11661166
* `actual` {any}
@@ -1339,7 +1339,7 @@ added: v0.1.21
13391339
changes:
13401340
- version: v10.0.0
13411341
pr-url: https://github.com/nodejs/node/pull/17003
1342-
description: Used comparison changed from Strict Equality to `Object.is()`
1342+
description: Used comparison changed from Strict Equality to `Object.is()`.
13431343
-->
13441344

13451345
* `actual` {any}

doc/api/async_hooks.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -544,7 +544,7 @@ added: v8.1.0
544544
changes:
545545
- version: v8.2.0
546546
pr-url: https://github.com/nodejs/node/pull/13490
547-
description: Renamed from `currentId`
547+
description: Renamed from `currentId`.
548548
-->
549549

550550
* Returns: {number} The `asyncId` of the current execution context. Useful to

doc/api/cli.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -274,7 +274,7 @@ changes:
274274
- version: v13.6.0
275275
pr-url: https://github.com/nodejs/node/pull/30980
276276
description: changed from `--experimental-wasi-unstable-preview0` to
277-
`--experimental-wasi-unstable-preview1`
277+
`--experimental-wasi-unstable-preview1`.
278278
-->
279279

280280
Enable experimental WebAssembly System Interface (WASI) support.
@@ -674,7 +674,7 @@ changes:
674674
- version: v12.0.0
675675
pr-url: https://github.com/nodejs/node/pull/27312
676676
description: Changed from `--diagnostic-report-directory` to
677-
`--report-directory`
677+
`--report-directory`.
678678
-->
679679

680680
Location at which the report will be generated.
@@ -689,7 +689,7 @@ changes:
689689
- version: v12.0.0
690690
pr-url: https://github.com/nodejs/node/pull/27312
691691
description: changed from `--diagnostic-report-filename` to
692-
`--report-filename`
692+
`--report-filename`.
693693
-->
694694

695695
Name of the file to which the report will be written.
@@ -704,7 +704,7 @@ changes:
704704
- version: v12.0.0
705705
pr-url: https://github.com/nodejs/node/pull/27312
706706
description: changed from `--diagnostic-report-on-fatalerror` to
707-
`--report-on-fatalerror`
707+
`--report-on-fatalerror`.
708708
-->
709709

710710
Enables the report to be triggered on fatal errors (internal errors within
@@ -723,7 +723,7 @@ changes:
723723
- version: v12.0.0
724724
pr-url: https://github.com/nodejs/node/pull/27312
725725
description: changed from `--diagnostic-report-on-signal` to
726-
`--report-on-signal`
726+
`--report-on-signal`.
727727
-->
728728

729729
Enables report to be generated upon receiving the specified (or predefined)
@@ -740,7 +740,7 @@ changes:
740740
- version: v12.0.0
741741
pr-url: https://github.com/nodejs/node/pull/27312
742742
description: changed from `--diagnostic-report-signal` to
743-
`--report-signal`
743+
`--report-signal`.
744744
-->
745745

746746
Sets or resets the signal for report generation (not supported on Windows).
@@ -756,7 +756,7 @@ changes:
756756
- version: v12.0.0
757757
pr-url: https://github.com/nodejs/node/pull/27312
758758
description: changed from `--diagnostic-report-uncaught-exception` to
759-
`--report-uncaught-exception`
759+
`--report-uncaught-exception`.
760760
-->
761761

762762
Enables report to be generated on uncaught exceptions. Useful when inspecting

doc/api/crypto.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -842,11 +842,11 @@ added: v0.11.14
842842
changes:
843843
- version: v6.0.0
844844
pr-url: https://github.com/nodejs/node/pull/5522
845-
description: The default `inputEncoding` changed from `binary` to `utf8`
845+
description: The default `inputEncoding` changed from `binary` to `utf8`.
846846
- version: v10.0.0
847847
pr-url: https://github.com/nodejs/node/pull/16849
848848
description: Changed error format to better support invalid public key
849-
error
849+
error.
850850
-->
851851

852852
* `otherPublicKey` {string | Buffer | TypedArray | DataView}
@@ -1249,14 +1249,14 @@ changes:
12491249
description: Added support for `'dh'`.
12501250
- version: v12.0.0
12511251
pr-url: https://github.com/nodejs/node/pull/26960
1252-
description: Added support for `'rsa-pss'`
1252+
description: Added support for `'rsa-pss'`.
12531253
- version: v12.0.0
12541254
pr-url: https://github.com/nodejs/node/pull/26786
12551255
description: This property now returns `undefined` for KeyObject
12561256
instances of unrecognized type instead of aborting.
12571257
- version: v12.0.0
12581258
pr-url: https://github.com/nodejs/node/pull/26774
1259-
description: Added support for `'x25519'` and `'x448'`
1259+
description: Added support for `'x25519'` and `'x448'`.
12601260
- version: v12.0.0
12611261
pr-url: https://github.com/nodejs/node/pull/26319
12621262
description: Added support for `'ed25519'` and `'ed448'`.

doc/api/fs.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -2922,7 +2922,7 @@ changes:
29222922
- version: v13.11.0
29232923
pr-url: https://github.com/nodejs/node/pull/31402
29242924
description: Options object can be passed in
2925-
to make Buffer, offset, length and position optional
2925+
to make Buffer, offset, length and position optional.
29262926
-->
29272927
* `fd` {integer}
29282928
* `options` {Object}
@@ -3220,7 +3220,7 @@ changes:
32203220
- version: v14.0.0
32213221
pr-url: https://github.com/nodejs/node/pull/32460
32223222
description: Options object can be passed in
3223-
to make offset, length and position optional
3223+
to make offset, length and position optional.
32243224
-->
32253225

32263226
* `fd` {integer}
@@ -3775,7 +3775,7 @@ changes:
37753775
- version: v12.0.0
37763776
pr-url: https://github.com/nodejs/node/pull/23724
37773777
description: If the `type` argument is left undefined, Node will autodetect
3778-
`target` type and automatically select `dir` or `file`
3778+
`target` type and automatically select `dir` or `file`.
37793779
-->
37803780

37813781
* `target` {string|Buffer|URL}
@@ -3823,7 +3823,7 @@ changes:
38233823
- version: v12.0.0
38243824
pr-url: https://github.com/nodejs/node/pull/23724
38253825
description: If the `type` argument is left undefined, Node will autodetect
3826-
`target` type and automatically select `dir` or `file`
3826+
`target` type and automatically select `dir` or `file`.
38273827
-->
38283828

38293829
* `target` {string|Buffer|URL}
@@ -4216,7 +4216,7 @@ changes:
42164216
- version: v10.10.0
42174217
pr-url: https://github.com/nodejs/node/pull/22150
42184218
description: The `buffer` parameter can now be any `TypedArray` or a
4219-
`DataView`
4219+
`DataView`.
42204220
- version: v10.0.0
42214221
pr-url: https://github.com/nodejs/node/pull/12562
42224222
description: The `callback` parameter is no longer optional. Not passing

doc/api/n-api.md

+5-6
Original file line numberDiff line numberDiff line change
@@ -3747,7 +3747,7 @@ if (status != napi_ok) return status;
37473747
changes:
37483748
- version: v14.12.0
37493749
pr-url: https://github.com/nodejs/node/pull/35214
3750-
description: added `napi_default_method` and `napi_default_property`
3750+
description: added `napi_default_method` and `napi_default_property`.
37513751
-->
37523752

37533753
```c
@@ -5784,13 +5784,12 @@ napiVersion: 4
57845784
changes:
57855785
- version: v14.5.0
57865786
pr-url: https://github.com/nodejs/node/pull/33453
5787-
description: >
5788-
Support for `napi_would_deadlock` has been reverted.
5787+
description: Support for `napi_would_deadlock` has been reverted.
57895788
- version: v14.1.0
57905789
pr-url: https://github.com/nodejs/node/pull/32689
5791-
description: >
5792-
Return `napi_would_deadlock` when called with `napi_tsfn_blocking` from
5793-
the main thread or a worker thread and the queue is full.
5790+
description: Return `napi_would_deadlock` when called with
5791+
`napi_tsfn_blocking` from the main thread or a worker thread
5792+
and the queue is full.
57945793
-->
57955794

57965795
```c

doc/api/os.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -324,7 +324,7 @@ changes:
324324
- version: v2.0.0
325325
pr-url: https://github.com/nodejs/node/pull/747
326326
description: This function is now cross-platform consistent and no longer
327-
returns a path with a trailing slash on any platform
327+
returns a path with a trailing slash on any platform.
328328
-->
329329

330330
* Returns: {string}

doc/api/vm.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ changes:
6161
- version: v10.6.0
6262
pr-url: https://github.com/nodejs/node/pull/20300
6363
description: The `produceCachedData` is deprecated in favour of
64-
`script.createCachedData()`
64+
`script.createCachedData()`.
6565
-->
6666

6767
* `code` {string} The JavaScript code to compile.
@@ -816,7 +816,8 @@ changes:
816816
description: The `importModuleDynamically` option is now supported.
817817
- version: v14.3.0
818818
pr-url: https://github.com/nodejs/node/pull/33364
819-
description: Removal of `importModuleDynamically` due to compatibility issues
819+
description: Removal of `importModuleDynamically` due to compatibility
820+
issues.
820821
-->
821822

822823
* `code` {string} The body of the function to compile.

0 commit comments

Comments
 (0)