FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

doc: space around lists · nodejs/node@2a53401 · GitHub

/ node Public

Commit 2a53401

Browse files
nschonni
authored and
BridgeAR
committed
doc: space around lists
Address markdownlint rule MD032. Flagged a few mixed list styles. PR-URL: #29467 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: David Carlier <devnexen@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
1 parent c1695c6 commit 2a53401

32 files changed

Lines changed: 249 additions & 16 deletions

‎COLLABORATOR_GUIDE.md‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -542,9 +542,7 @@ Save the file and close the editor. When prompted, enter a new commit message
542542
for that commit. This is an opportunity to fix commit messages.
543543

544544
* The commit message text must conform to the [commit message guidelines][].
545-
546-
<a name="metadata"></a>
547-
* Change the original commit message to include metadata. (The
545+
* <a name="metadata"></a>Change the original commit message to include metadata. (The
548546
[`git node metadata`][git-node-metadata] command can generate the metadata
549547
for you.)
550548

‎CPP_STYLE_GUIDE.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ features and idioms, as well as have some specific guidelines for the use of
3636
runtime features.
3737

3838
Coding guidelines are based on the following guides (highest priority first):
39+
3940
1. This document
4041
2. The [Google C++ Style Guide][]
4142
3. The ISO [C++ Core Guidelines][]
@@ -284,6 +285,7 @@ data[0] = 12345;
284285
[Run Time Type Information][]
285286

286287
Further reading:
288+
287289
* [ES.48]: Avoid casts
288290
* [ES.49]: If you must use a cast, use a named cast
289291

‎doc/STYLE_GUIDE.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@
5656
<!--lint disable prohibited-strings remark-lint-->
5757
* NOT OK: Javascript, Google's v8
5858
<!-- lint enable prohibited-strings remark-lint-->
59+
5960
* Use _Node.js_ and not _Node_, _NodeJS_, or similar variants.
6061
* When referring to the executable, _`node`_ is acceptable.
6162

‎doc/api/addons.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -143,6 +143,7 @@ followed by a function body.
143143

144144
The following three variables may be used inside the function body following an
145145
invocation of `NODE_MODULE_INIT()`:
146+
146147
* `Local<Object> exports`,
147148
* `Local<Value> module`, and
148149
* `Local<Context> context`
@@ -158,6 +159,7 @@ they were created.
158159

159160
The context-aware addon can be structured to avoid global static data by
160161
performing the following steps:
162+
161163
* defining a class which will hold per-addon-instance data. Such
162164
a class should include a `v8::Persistent<v8::Object>` which will hold a weak
163165
reference to the addon's `exports` object. The callback associated with the weak
@@ -259,6 +261,7 @@ signature.
259261

260262
In order to be loaded from multiple Node.js environments,
261263
such as a main thread and a Worker thread, an add-on needs to either:
264+
262265
- Be an N-API addon, or
263266
- Be declared as context-aware using `NODE_MODULE_INIT()` as described above
264267

‎doc/api/assert.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ will be instances of the `AssertionError` class.
1919
<!-- YAML
2020
added: v0.1.21
2121
-->
22+
2223
* `options` {Object}
2324
* `message` {string} If provided, the error message is set to this value.
2425
* `actual` {any} The `actual` property on the error instance.
@@ -145,6 +146,7 @@ assert.deepEqual(/a/gi, new Date());
145146
<!-- YAML
146147
added: v0.5.9
147148
-->
149+
148150
* `value` {any} The input that is checked for being truthy.
149151
* `message` {string|Error}
150152

@@ -174,6 +176,7 @@ changes:
174176
pr-url: https://github.com/nodejs/node/pull/5910
175177
description: Handle non-`Uint8Array` typed arrays correctly.
176178
-->
179+
177180
* `actual` {any}
178181
* `expected` {any}
179182
* `message` {string|Error}
@@ -291,6 +294,7 @@ changes:
291294
pr-url: https://github.com/nodejs/node/pull/5910
292295
description: Handle non-`Uint8Array` typed arrays correctly.
293296
-->
297+
294298
* `actual` {any}
295299
* `expected` {any}
296300
* `message` {string|Error}
@@ -420,6 +424,7 @@ parameter is an instance of an [`Error`][] then it will be thrown instead of the
420424
<!-- YAML
421425
added: v10.0.0
422426
-->
427+
423428
* `asyncFn` {Function|Promise}
424429
* `error` {RegExp|Function}
425430
* `message` {string}
@@ -476,6 +481,7 @@ changes:
476481
pr-url: https://github.com/nodejs/node/pull/3276
477482
description: The `error` parameter can now be an arrow function.
478483
-->
484+
479485
* `fn` {Function}
480486
* `error` {RegExp|Function}
481487
* `message` {string}
@@ -544,6 +550,7 @@ assert.doesNotThrow(
544550
<!-- YAML
545551
added: v0.1.21
546552
-->
553+
547554
* `actual` {any}
548555
* `expected` {any}
549556
* `message` {string|Error}
@@ -583,6 +590,7 @@ parameter is an instance of an [`Error`][] then it will be thrown instead of the
583590
<!-- YAML
584591
added: v0.1.21
585592
-->
593+
586594
* `message` {string|Error} **Default:** `'Failed'`
587595

588596
Throws an `AssertionError` with the provided error message or a default error
@@ -614,6 +622,7 @@ changes:
614622
description: Calling `assert.fail()` with more than one argument is
615623
deprecated and emits a warning.
616624
-->
625+
617626
* `actual` {any}
618627
* `expected` {any}
619628
* `message` {string|Error}
@@ -680,6 +689,7 @@ changes:
680689
description: Value may now only be `undefined` or `null`. Before all falsy
681690
values were handled the same as `null` and did not throw.
682691
-->
692+
683693
* `value` {any}
684694

685695
Throws `value` if `value` is not `undefined` or `null`. This is useful when
@@ -733,6 +743,7 @@ changes:
733743
pr-url: https://github.com/nodejs/node/pull/5910
734744
description: Handle non-`Uint8Array` typed arrays correctly.
735745
-->
746+
736747
* `actual` {any}
737748
* `expected` {any}
738749
* `message` {string|Error}
@@ -814,6 +825,7 @@ changes:
814825
pr-url: https://github.com/nodejs/node/pull/5910
815826
description: Handle non-`Uint8Array` typed arrays correctly.
816827
-->
828+
817829
* `actual` {any}
818830
* `expected` {any}
819831
* `message` {string|Error}
@@ -837,6 +849,7 @@ instead of the `AssertionError`.
837849
<!-- YAML
838850
added: v0.1.21
839851
-->
852+
840853
* `actual` {any}
841854
* `expected` {any}
842855
* `message` {string|Error}
@@ -879,6 +892,7 @@ changes:
879892
pr-url: https://github.com/nodejs/node/pull/17003
880893
description: Used comparison changed from Strict Equality to `Object.is()`
881894
-->
895+
882896
* `actual` {any}
883897
* `expected` {any}
884898
* `message` {string|Error}
@@ -916,6 +930,7 @@ changes:
916930
description: The `assert.ok()` (no arguments) will now use a predefined
917931
error message.
918932
-->
933+
919934
* `value` {any}
920935
* `message` {string|Error}
921936

@@ -978,6 +993,7 @@ assert(0);
978993
<!-- YAML
979994
added: v10.0.0
980995
-->
996+
981997
* `asyncFn` {Function|Promise}
982998
* `error` {RegExp|Function|Object|Error}
983999
* `message` {string}
@@ -1040,6 +1056,7 @@ changes:
10401056
pr-url: https://github.com/nodejs/node/pull/17003
10411057
description: Used comparison changed from Strict Equality to `Object.is()`
10421058
-->
1059+
10431060
* `actual` {any}
10441061
* `expected` {any}
10451062
* `message` {string|Error}
@@ -1096,6 +1113,7 @@ changes:
10961113
pr-url: https://github.com/nodejs/node/pull/3276
10971114
description: The `error` parameter can now be an arrow function.
10981115
-->
1116+
10991117
* `fn` {Function}
11001118
* `error` {RegExp|Function|Object|Error}
11011119
* `message` {string}

‎doc/api/console.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,7 @@ changes:
138138
description: The implementation is now spec compliant and does not throw
139139
anymore.
140140
-->
141+
141142
* `value` {any} The value tested for being truthy.
142143
* `...message` {any} All arguments besides `value` are used as error message.
143144

@@ -233,6 +234,7 @@ changes:
233234
pr-url: https://github.com/nodejs/node/pull/17033
234235
description: "`console.debug` is now an alias for `console.log`."
235236
-->
237+
236238
* `data` {any}
237239
* `...args` {any}
238240

@@ -242,6 +244,7 @@ The `console.debug()` function is an alias for [`console.log()`][].
242244
<!-- YAML
243245
added: v0.1.101
244246
-->
247+
245248
* `obj` {any}
246249
* `options` {Object}
247250
* `showHidden` {boolean} If `true` then the object's non-enumerable and symbol
@@ -264,6 +267,7 @@ changes:
264267
pr-url: https://github.com/nodejs/node/pull/17152
265268
description: "`console.dirxml` now calls `console.log` for its arguments."
266269
-->
270+
267271
* `...data` {any}
268272

269273
This method calls `console.log()` passing it the arguments received.
@@ -273,6 +277,7 @@ This method does not produce any XML formatting.
273277
<!-- YAML
274278
added: v0.1.100
275279
-->
280+
276281
* `data` {any}
277282
* `...args` {any}
278283

@@ -323,6 +328,7 @@ Decreases indentation of subsequent lines by two spaces.
323328
<!-- YAML
324329
added: v0.1.100
325330
-->
331+
326332
* `data` {any}
327333
* `...args` {any}
328334

@@ -332,6 +338,7 @@ The `console.info()` function is an alias for [`console.log()`][].
332338
<!-- YAML
333339
added: v0.1.100
334340
-->
341+
335342
* `data` {any}
336343
* `...args` {any}
337344

@@ -391,6 +398,7 @@ console.table([{ a: 1, b: 'Y' }, { a: 'Z', b: 2 }], ['a']);
391398
<!-- YAML
392399
added: v0.1.104
393400
-->
401+
394402
* `label` {string} **Default:** `'default'`
395403

396404
Starts a timer that can be used to compute the duration of an operation. Timers
@@ -407,6 +415,7 @@ changes:
407415
description: This method no longer supports multiple calls that don’t map
408416
to individual `console.time()` calls; see below for details.
409417
-->
418+
410419
* `label` {string} **Default:** `'default'`
411420

412421
Stops a timer that was previously started by calling [`console.time()`][] and
@@ -423,6 +432,7 @@ console.timeEnd('100-elements');
423432
<!-- YAML
424433
added: v10.7.0
425434
-->
435+
426436
* `label` {string} **Default:** `'default'`
427437
* `...data` {any}
428438

@@ -442,6 +452,7 @@ console.timeEnd('process');
442452
<!-- YAML
443453
added: v0.1.104
444454
-->
455+
445456
* `message` {any}
446457
* `...args` {any}
447458

@@ -468,6 +479,7 @@ console.trace('Show me');
468479
<!-- YAML
469480
added: v0.1.100
470481
-->
482+
471483
* `data` {any}
472484
* `...args` {any}
473485

@@ -482,6 +494,7 @@ not display anything unless used in conjunction with the [inspector][]
482494
<!-- YAML
483495
added: v8.0.0
484496
-->
497+
485498
* `label` {string} **Default:** `'default'`
486499

487500
This method does not display anything unless used in the inspector. The
@@ -492,6 +505,7 @@ This method does not display anything unless used in the inspector. The
492505
<!-- YAML
493506
added: v8.0.0
494507
-->
508+
495509
* `label` {string}
496510

497511
This method does not display anything unless used in the inspector. The
@@ -510,6 +524,7 @@ console.profileEnd('MyLabel');
510524
<!-- YAML
511525
added: v8.0.0
512526
-->
527+
513528
* `label` {string}
514529

515530
This method does not display anything unless used in the inspector. Stops the
@@ -524,6 +539,7 @@ stopped.
524539
<!-- YAML
525540
added: v8.0.0
526541
-->
542+
527543
* `label` {string}
528544

529545
This method does not display anything unless used in the inspector. The
@@ -534,6 +550,7 @@ This method does not display anything unless used in the inspector. The
534550
<!-- YAML
535551
added: v8.0.0
536552
-->
553+
537554
* `label` {string} **Default:** `'default'`
538555

539556
This method does not display anything unless used in the inspector. The
@@ -543,6 +560,7 @@ This method does not display anything unless used in the inspector. The
543560
<!-- YAML
544561
added: v8.0.0
545562
-->
563+
546564
* `label` {string} **Default:** `'default'`
547565

548566
This method does not display anything unless used in the inspector. The

0 commit comments

Comments
 (0)
Back | FazBrowse Home | New Git URL