Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: space around lists #29467

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions COLLABORATOR_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -542,9 +542,7 @@ Save the file and close the editor. When prompted, enter a new commit message
for that commit. This is an opportunity to fix commit messages.

* The commit message text must conform to the [commit message guidelines][].

<a name="metadata"></a>
* Change the original commit message to include metadata. (The
* <a name="metadata"></a>Change the original commit message to include metadata. (The
Trott marked this conversation as resolved.
Show resolved Hide resolved
[`git node metadata`][git-node-metadata] command can generate the metadata
for you.)

Expand Down
2 changes: 2 additions & 0 deletions CPP_STYLE_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ features and idioms, as well as have some specific guidelines for the use of
runtime features.

Coding guidelines are based on the following guides (highest priority first):

1. This document
2. The [Google C++ Style Guide][]
3. The ISO [C++ Core Guidelines][]
Expand Down Expand Up @@ -284,6 +285,7 @@ data[0] = 12345;
[Run Time Type Information][]

Further reading:

* [ES.48]: Avoid casts
* [ES.49]: If you must use a cast, use a named cast

Expand Down
1 change: 1 addition & 0 deletions doc/STYLE_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@
<!--lint disable prohibited-strings remark-lint-->
* NOT OK: Javascript, Google's v8
<!-- lint enable prohibited-strings remark-lint-->

* Use _Node.js_ and not _Node_, _NodeJS_, or similar variants.
* When referring to the executable, _`node`_ is acceptable.

Expand Down
3 changes: 3 additions & 0 deletions doc/api/addons.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,7 @@ followed by a function body.
The following three variables may be used inside the function body following an
invocation of `NODE_MODULE_INIT()`:
* `Local<Object> exports`,
* `Local<Value> module`, and
* `Local<Context> context`
Expand All @@ -158,6 +159,7 @@ they were created.
The context-aware addon can be structured to avoid global static data by
performing the following steps:
* defining a class which will hold per-addon-instance data. Such
a class should include a `v8::Persistent<v8::Object>` which will hold a weak
reference to the addon's `exports` object. The callback associated with the weak
Expand Down Expand Up @@ -259,6 +261,7 @@ signature.
In order to be loaded from multiple Node.js environments,
such as a main thread and a Worker thread, an add-on needs to either:
- Be an N-API addon, or
- Be declared as context-aware using `NODE_MODULE_INIT()` as described above
Expand Down
18 changes: 18 additions & 0 deletions doc/api/assert.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ will be instances of the `AssertionError` class.
<!-- YAML
added: v0.1.21
-->

* `options` {Object}
* `message` {string} If provided, the error message is set to this value.
* `actual` {any} The `actual` property on the error instance.
Expand Down Expand Up @@ -145,6 +146,7 @@ assert.deepEqual(/a/gi, new Date());
<!-- YAML
added: v0.5.9
-->

* `value` {any} The input that is checked for being truthy.
* `message` {string|Error}

Expand Down Expand Up @@ -174,6 +176,7 @@ changes:
pr-url: https://github.com/nodejs/node/pull/5910
description: Handle non-`Uint8Array` typed arrays correctly.
-->

* `actual` {any}
* `expected` {any}
* `message` {string|Error}
Expand Down Expand Up @@ -291,6 +294,7 @@ changes:
pr-url: https://github.com/nodejs/node/pull/5910
description: Handle non-`Uint8Array` typed arrays correctly.
-->

* `actual` {any}
* `expected` {any}
* `message` {string|Error}
Expand Down Expand Up @@ -420,6 +424,7 @@ parameter is an instance of an [`Error`][] then it will be thrown instead of the
<!-- YAML
added: v10.0.0
-->

* `asyncFn` {Function|Promise}
* `error` {RegExp|Function}
* `message` {string}
Expand Down Expand Up @@ -476,6 +481,7 @@ changes:
pr-url: https://github.com/nodejs/node/pull/3276
description: The `error` parameter can now be an arrow function.
-->

* `fn` {Function}
* `error` {RegExp|Function}
* `message` {string}
Expand Down Expand Up @@ -544,6 +550,7 @@ assert.doesNotThrow(
<!-- YAML
added: v0.1.21
-->

* `actual` {any}
* `expected` {any}
* `message` {string|Error}
Expand Down Expand Up @@ -583,6 +590,7 @@ parameter is an instance of an [`Error`][] then it will be thrown instead of the
<!-- YAML
added: v0.1.21
-->

* `message` {string|Error} **Default:** `'Failed'`

Throws an `AssertionError` with the provided error message or a default error
Expand Down Expand Up @@ -614,6 +622,7 @@ changes:
description: Calling `assert.fail()` with more than one argument is
deprecated and emits a warning.
-->

* `actual` {any}
* `expected` {any}
* `message` {string|Error}
Expand Down Expand Up @@ -680,6 +689,7 @@ changes:
description: Value may now only be `undefined` or `null`. Before all falsy
values were handled the same as `null` and did not throw.
-->

* `value` {any}

Throws `value` if `value` is not `undefined` or `null`. This is useful when
Expand Down Expand Up @@ -733,6 +743,7 @@ changes:
pr-url: https://github.com/nodejs/node/pull/5910
description: Handle non-`Uint8Array` typed arrays correctly.
-->

* `actual` {any}
* `expected` {any}
* `message` {string|Error}
Expand Down Expand Up @@ -814,6 +825,7 @@ changes:
pr-url: https://github.com/nodejs/node/pull/5910
description: Handle non-`Uint8Array` typed arrays correctly.
-->

* `actual` {any}
* `expected` {any}
* `message` {string|Error}
Expand All @@ -837,6 +849,7 @@ instead of the `AssertionError`.
<!-- YAML
added: v0.1.21
-->

* `actual` {any}
* `expected` {any}
* `message` {string|Error}
Expand Down Expand Up @@ -879,6 +892,7 @@ changes:
pr-url: https://github.com/nodejs/node/pull/17003
description: Used comparison changed from Strict Equality to `Object.is()`
-->

* `actual` {any}
* `expected` {any}
* `message` {string|Error}
Expand Down Expand Up @@ -916,6 +930,7 @@ changes:
description: The `assert.ok()` (no arguments) will now use a predefined
error message.
-->

* `value` {any}
* `message` {string|Error}

Expand Down Expand Up @@ -978,6 +993,7 @@ assert(0);
<!-- YAML
added: v10.0.0
-->

* `asyncFn` {Function|Promise}
* `error` {RegExp|Function|Object|Error}
* `message` {string}
Expand Down Expand Up @@ -1040,6 +1056,7 @@ changes:
pr-url: https://github.com/nodejs/node/pull/17003
description: Used comparison changed from Strict Equality to `Object.is()`
-->

* `actual` {any}
* `expected` {any}
* `message` {string|Error}
Expand Down Expand Up @@ -1096,6 +1113,7 @@ changes:
pr-url: https://github.com/nodejs/node/pull/3276
description: The `error` parameter can now be an arrow function.
-->

* `fn` {Function}
* `error` {RegExp|Function|Object|Error}
* `message` {string}
Expand Down
18 changes: 18 additions & 0 deletions doc/api/console.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,7 @@ changes:
description: The implementation is now spec compliant and does not throw
anymore.
-->

* `value` {any} The value tested for being truthy.
* `...message` {any} All arguments besides `value` are used as error message.

Expand Down Expand Up @@ -233,6 +234,7 @@ changes:
pr-url: https://github.com/nodejs/node/pull/17033
description: "`console.debug` is now an alias for `console.log`."
-->

* `data` {any}
* `...args` {any}

Expand All @@ -242,6 +244,7 @@ The `console.debug()` function is an alias for [`console.log()`][].
<!-- YAML
added: v0.1.101
-->

* `obj` {any}
* `options` {Object}
* `showHidden` {boolean} If `true` then the object's non-enumerable and symbol
Expand All @@ -264,6 +267,7 @@ changes:
pr-url: https://github.com/nodejs/node/pull/17152
description: "`console.dirxml` now calls `console.log` for its arguments."
-->

* `...data` {any}

This method calls `console.log()` passing it the arguments received.
Expand All @@ -273,6 +277,7 @@ This method does not produce any XML formatting.
<!-- YAML
added: v0.1.100
-->

* `data` {any}
* `...args` {any}

Expand Down Expand Up @@ -323,6 +328,7 @@ Decreases indentation of subsequent lines by two spaces.
<!-- YAML
added: v0.1.100
-->

* `data` {any}
* `...args` {any}

Expand All @@ -332,6 +338,7 @@ The `console.info()` function is an alias for [`console.log()`][].
<!-- YAML
added: v0.1.100
-->

* `data` {any}
* `...args` {any}

Expand Down Expand Up @@ -391,6 +398,7 @@ console.table([{ a: 1, b: 'Y' }, { a: 'Z', b: 2 }], ['a']);
<!-- YAML
added: v0.1.104
-->

* `label` {string} **Default:** `'default'`

Starts a timer that can be used to compute the duration of an operation. Timers
Expand All @@ -407,6 +415,7 @@ changes:
description: This method no longer supports multiple calls that don’t map
to individual `console.time()` calls; see below for details.
-->

* `label` {string} **Default:** `'default'`

Stops a timer that was previously started by calling [`console.time()`][] and
Expand All @@ -423,6 +432,7 @@ console.timeEnd('100-elements');
<!-- YAML
added: v10.7.0
-->

* `label` {string} **Default:** `'default'`
* `...data` {any}

Expand All @@ -442,6 +452,7 @@ console.timeEnd('process');
<!-- YAML
added: v0.1.104
-->

* `message` {any}
* `...args` {any}

Expand All @@ -468,6 +479,7 @@ console.trace('Show me');
<!-- YAML
added: v0.1.100
-->

* `data` {any}
* `...args` {any}

Expand All @@ -482,6 +494,7 @@ not display anything unless used in conjunction with the [inspector][]
<!-- YAML
added: v8.0.0
-->

* `label` {string} **Default:** `'default'`

This method does not display anything unless used in the inspector. The
Expand All @@ -492,6 +505,7 @@ This method does not display anything unless used in the inspector. The
<!-- YAML
added: v8.0.0
-->

* `label` {string}

This method does not display anything unless used in the inspector. The
Expand All @@ -510,6 +524,7 @@ console.profileEnd('MyLabel');
<!-- YAML
added: v8.0.0
-->

* `label` {string}

This method does not display anything unless used in the inspector. Stops the
Expand All @@ -524,6 +539,7 @@ stopped.
<!-- YAML
added: v8.0.0
-->

* `label` {string}

This method does not display anything unless used in the inspector. The
Expand All @@ -534,6 +550,7 @@ This method does not display anything unless used in the inspector. The
<!-- YAML
added: v8.0.0
-->

* `label` {string} **Default:** `'default'`

This method does not display anything unless used in the inspector. The
Expand All @@ -543,6 +560,7 @@ This method does not display anything unless used in the inspector. The
<!-- YAML
added: v8.0.0
-->

* `label` {string} **Default:** `'default'`

This method does not display anything unless used in the inspector. The
Expand Down
Loading