Skip to content

Commit 0c8e039

Browse files
aduh95joesepi
authored andcommitted
doc: changes description must end with a period
Refs: nodejs/remark-preset-lint-node#139 PR-URL: nodejs#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 c8e9118 commit 0c8e039

File tree

8 files changed

+39
-39
lines changed

8 files changed

+39
-39
lines changed

doc/api/assert.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ added: v9.9.0
1515
changes:
1616
- version: REPLACEME
1717
pr-url: https://github.com/nodejs/node/pull/34001
18-
description: Exposed as `require('assert/strict')`
18+
description: Exposed as `require('assert/strict')`.
1919
- version:
2020
- v13.9.0
2121
- v12.16.2
@@ -330,10 +330,10 @@ changes:
330330
minor comparison adjustments to make the check less surprising.
331331
- version: v9.0.0
332332
pr-url: https://github.com/nodejs/node/pull/15001
333-
description: The `Error` names and messages are now properly compared
333+
description: The `Error` names and messages are now properly compared.
334334
- version: v8.0.0
335335
pr-url: https://github.com/nodejs/node/pull/12142
336-
description: The `Set` and `Map` content is also compared
336+
description: The `Set` and `Map` content is also compared.
337337
- version:
338338
- v6.4.0
339339
- v4.7.1
@@ -456,10 +456,10 @@ changes:
456456
comparison.
457457
- version: v8.5.0
458458
pr-url: https://github.com/nodejs/node/pull/15001
459-
description: The `Error` names and messages are now properly compared
459+
description: The `Error` names and messages are now properly compared.
460460
- version: v8.0.0
461461
pr-url: https://github.com/nodejs/node/pull/12142
462-
description: The `Set` and `Map` content is also compared
462+
description: The `Set` and `Map` content is also compared.
463463
- version:
464464
- v6.4.0
465465
- v4.7.1
@@ -999,10 +999,10 @@ changes:
999999
NaN.
10001000
- version: v9.0.0
10011001
pr-url: https://github.com/nodejs/node/pull/15001
1002-
description: The `Error` names and messages are now properly compared
1002+
description: The `Error` names and messages are now properly compared.
10031003
- version: v8.0.0
10041004
pr-url: https://github.com/nodejs/node/pull/12142
1005-
description: The `Set` and `Map` content is also compared
1005+
description: The `Set` and `Map` content is also compared.
10061006
- version:
10071007
- v6.4.0
10081008
- v4.7.1
@@ -1087,10 +1087,10 @@ changes:
10871087
comparison.
10881088
- version: v9.0.0
10891089
pr-url: https://github.com/nodejs/node/pull/15001
1090-
description: The `Error` names and messages are now properly compared
1090+
description: The `Error` names and messages are now properly compared.
10911091
- version: v8.0.0
10921092
pr-url: https://github.com/nodejs/node/pull/12142
1093-
description: The `Set` and `Map` content is also compared
1093+
description: The `Set` and `Map` content is also compared.
10941094
- version:
10951095
- v6.4.0
10961096
- v4.7.1
@@ -1176,7 +1176,7 @@ added: v0.1.21
11761176
changes:
11771177
- version: v10.0.0
11781178
pr-url: https://github.com/nodejs/node/pull/17003
1179-
description: Used comparison changed from Strict Equality to `Object.is()`
1179+
description: Used comparison changed from Strict Equality to `Object.is()`.
11801180
-->
11811181

11821182
* `actual` {any}
@@ -1355,7 +1355,7 @@ added: v0.1.21
13551355
changes:
13561356
- version: v10.0.0
13571357
pr-url: https://github.com/nodejs/node/pull/17003
1358-
description: Used comparison changed from Strict Equality to `Object.is()`
1358+
description: Used comparison changed from Strict Equality to `Object.is()`.
13591359
-->
13601360

13611361
* `actual` {any}

doc/api/async_hooks.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -546,7 +546,7 @@ added: v8.1.0
546546
changes:
547547
- version: v8.2.0
548548
pr-url: https://github.com/nodejs/node/pull/13490
549-
description: Renamed from `currentId`
549+
description: Renamed from `currentId`.
550550
-->
551551

552552
* 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
@@ -290,7 +290,7 @@ changes:
290290
- version: v13.6.0
291291
pr-url: https://github.com/nodejs/node/pull/30980
292292
description: changed from `--experimental-wasi-unstable-preview0` to
293-
`--experimental-wasi-unstable-preview1`
293+
`--experimental-wasi-unstable-preview1`.
294294
-->
295295

296296
Enable experimental WebAssembly System Interface (WASI) support.
@@ -702,7 +702,7 @@ changes:
702702
- version: v12.0.0
703703
pr-url: https://github.com/nodejs/node/pull/27312
704704
description: Changed from `--diagnostic-report-directory` to
705-
`--report-directory`
705+
`--report-directory`.
706706
-->
707707

708708
Location at which the report will be generated.
@@ -719,7 +719,7 @@ changes:
719719
- version: v12.0.0
720720
pr-url: https://github.com/nodejs/node/pull/27312
721721
description: changed from `--diagnostic-report-filename` to
722-
`--report-filename`
722+
`--report-filename`.
723723
-->
724724

725725
Name of the file to which the report will be written.
@@ -737,7 +737,7 @@ changes:
737737
- version: v12.0.0
738738
pr-url: https://github.com/nodejs/node/pull/27312
739739
description: changed from `--diagnostic-report-on-fatalerror` to
740-
`--report-on-fatalerror`
740+
`--report-on-fatalerror`.
741741
-->
742742

743743
Enables the report to be triggered on fatal errors (internal errors within
@@ -758,7 +758,7 @@ changes:
758758
- version: v12.0.0
759759
pr-url: https://github.com/nodejs/node/pull/27312
760760
description: changed from `--diagnostic-report-on-signal` to
761-
`--report-on-signal`
761+
`--report-on-signal`.
762762
-->
763763

764764
Enables report to be generated upon receiving the specified (or predefined)
@@ -777,7 +777,7 @@ changes:
777777
- version: v12.0.0
778778
pr-url: https://github.com/nodejs/node/pull/27312
779779
description: changed from `--diagnostic-report-signal` to
780-
`--report-signal`
780+
`--report-signal`.
781781
-->
782782

783783
Sets or resets the signal for report generation (not supported on Windows).
@@ -795,7 +795,7 @@ changes:
795795
- version: v12.0.0
796796
pr-url: https://github.com/nodejs/node/pull/27312
797797
description: changed from `--diagnostic-report-uncaught-exception` to
798-
`--report-uncaught-exception`
798+
`--report-uncaught-exception`.
799799
-->
800800

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

doc/api/crypto.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -514,7 +514,7 @@ added: v1.0.0
514514
changes:
515515
- version: REPLACEME
516516
pr-url: https://github.com/nodejs/node/pull/35093
517-
decription: The buffer argument can be a string or ArrayBuffer and is
517+
description: The buffer argument can be a string or ArrayBuffer and is
518518
limited to no more than 2 ** 31 - 1 bytes.
519519
- version: v7.2.0
520520
pr-url: https://github.com/nodejs/node/pull/9398
@@ -543,7 +543,7 @@ added: v1.0.0
543543
changes:
544544
- version: REPLACEME
545545
pr-url: https://github.com/nodejs/node/pull/35093
546-
decription: The buffer argument can be a string or ArrayBuffer and is
546+
description: The buffer argument can be a string or ArrayBuffer and is
547547
limited to no more than 2 ** 31 - 1 bytes.
548548
- version: v11.0.0
549549
pr-url: https://github.com/nodejs/node/pull/17825
@@ -884,11 +884,11 @@ added: v0.11.14
884884
changes:
885885
- version: v6.0.0
886886
pr-url: https://github.com/nodejs/node/pull/5522
887-
description: The default `inputEncoding` changed from `binary` to `utf8`
887+
description: The default `inputEncoding` changed from `binary` to `utf8`.
888888
- version: v10.0.0
889889
pr-url: https://github.com/nodejs/node/pull/16849
890890
description: Changed error format to better support invalid public key
891-
error
891+
error.
892892
-->
893893

894894
* `otherPublicKey` {string|ArrayBuffer|Buffer|TypedArray|DataView}
@@ -1295,14 +1295,14 @@ changes:
12951295
description: Added support for `'dh'`.
12961296
- version: v12.0.0
12971297
pr-url: https://github.com/nodejs/node/pull/26960
1298-
description: Added support for `'rsa-pss'`
1298+
description: Added support for `'rsa-pss'`.
12991299
- version: v12.0.0
13001300
pr-url: https://github.com/nodejs/node/pull/26786
13011301
description: This property now returns `undefined` for KeyObject
13021302
instances of unrecognized type instead of aborting.
13031303
- version: v12.0.0
13041304
pr-url: https://github.com/nodejs/node/pull/26774
1305-
description: Added support for `'x25519'` and `'x448'`
1305+
description: Added support for `'x25519'` and `'x448'`.
13061306
- version: v12.0.0
13071307
pr-url: https://github.com/nodejs/node/pull/26319
13081308
description: Added support for `'ed25519'` and `'ed448'`.

doc/api/fs.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -2938,7 +2938,7 @@ changes:
29382938
- v12.17.0
29392939
pr-url: https://github.com/nodejs/node/pull/31402
29402940
description: Options object can be passed in
2941-
to make Buffer, offset, length and position optional
2941+
to make Buffer, offset, length and position optional.
29422942
-->
29432943
* `fd` {integer}
29442944
* `options` {Object}
@@ -3240,7 +3240,7 @@ changes:
32403240
- v12.17.0
32413241
pr-url: https://github.com/nodejs/node/pull/32460
32423242
description: Options object can be passed in
3243-
to make offset, length and position optional
3243+
to make offset, length and position optional.
32443244
-->
32453245

32463246
* `fd` {integer}
@@ -3799,7 +3799,7 @@ changes:
37993799
- version: v12.0.0
38003800
pr-url: https://github.com/nodejs/node/pull/23724
38013801
description: If the `type` argument is left undefined, Node will autodetect
3802-
`target` type and automatically select `dir` or `file`
3802+
`target` type and automatically select `dir` or `file`.
38033803
-->
38043804

38053805
* `target` {string|Buffer|URL}
@@ -3847,7 +3847,7 @@ changes:
38473847
- version: v12.0.0
38483848
pr-url: https://github.com/nodejs/node/pull/23724
38493849
description: If the `type` argument is left undefined, Node will autodetect
3850-
`target` type and automatically select `dir` or `file`
3850+
`target` type and automatically select `dir` or `file`.
38513851
-->
38523852

38533853
* `target` {string|Buffer|URL}
@@ -4240,7 +4240,7 @@ changes:
42404240
- version: v10.10.0
42414241
pr-url: https://github.com/nodejs/node/pull/22150
42424242
description: The `buffer` parameter can now be any `TypedArray` or a
4243-
`DataView`
4243+
`DataView`.
42444244
- version: v10.0.0
42454245
pr-url: https://github.com/nodejs/node/pull/12562
42464246
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
@@ -3764,7 +3764,7 @@ if (status != napi_ok) return status;
37643764
changes:
37653765
- version: v14.12.0
37663766
pr-url: https://github.com/nodejs/node/pull/35214
3767-
description: added `napi_default_method` and `napi_default_property`
3767+
description: added `napi_default_method` and `napi_default_property`.
37683768
-->
37693769

37703770
```c
@@ -5806,13 +5806,12 @@ napiVersion: 4
58065806
changes:
58075807
- version: v14.5.0
58085808
pr-url: https://github.com/nodejs/node/pull/33453
5809-
description: >
5810-
Support for `napi_would_deadlock` has been reverted.
5809+
description: Support for `napi_would_deadlock` has been reverted.
58115810
- version: v14.1.0
58125811
pr-url: https://github.com/nodejs/node/pull/32689
5813-
description: >
5814-
Return `napi_would_deadlock` when called with `napi_tsfn_blocking` from
5815-
the main thread or a worker thread and the queue is full.
5812+
description: Return `napi_would_deadlock` when called with
5813+
`napi_tsfn_blocking` from the main thread or a worker thread
5814+
and the queue is full.
58165815
-->
58175816

58185817
```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.
@@ -820,7 +820,8 @@ changes:
820820
description: The `importModuleDynamically` option is now supported.
821821
- version: v14.3.0
822822
pr-url: https://github.com/nodejs/node/pull/33364
823-
description: Removal of `importModuleDynamically` due to compatibility issues
823+
description: Removal of `importModuleDynamically` due to compatibility
824+
issues.
824825
-->
825826

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

0 commit comments

Comments
 (0)