Skip to content

Commit d796bc7

Browse files
TrottBethGriggs
authored andcommittedDec 15, 2020
doc: update list styles for remark-parse@9 rendering
remark-parse@9.0.0 combined with our html.js tool ends a list if a multi-line item does not include indentation. Update our docs for this formatting. I looked around for a lint rule to enforce this but didn't find one readily available. (Happy to be shown that I'm wrong about that!) We may need to write one. PR-URL: #36049 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
1 parent 5a41282 commit d796bc7

16 files changed

+108
-107
lines changed
 

‎doc/api/addons.md

+16-15
Original file line numberDiff line numberDiff line change
@@ -154,25 +154,26 @@ they were created.
154154
155155
The context-aware addon can be structured to avoid global static data by
156156
performing the following steps:
157+
157158
* Define a class which will hold per-addon-instance data and which has a static
158-
member of the form
159+
member of the form
159160
```cpp
160161
static void DeleteInstance(void* data) {
161162
// Cast `data` to an instance of the class and delete it.
162163
}
163164
```
164165
* Heap-allocate an instance of this class in the addon initializer. This can be
165-
accomplished using the `new` keyword.
166+
accomplished using the `new` keyword.
166167
* Call `node::AddEnvironmentCleanupHook()`, passing it the above-created
167-
instance and a pointer to `DeleteInstance()`. This will ensure the instance is
168-
deleted when the environment is torn down.
168+
instance and a pointer to `DeleteInstance()`. This will ensure the instance is
169+
deleted when the environment is torn down.
169170
* Store the instance of the class in a `v8::External`, and
170171
* Pass the `v8::External` to all methods exposed to JavaScript by passing it
171-
to `v8::FunctionTemplate::New()` or `v8::Function::New()` which creates the
172-
native-backed JavaScript functions. The third parameter of
173-
`v8::FunctionTemplate::New()` or `v8::Function::New()` accepts the
174-
`v8::External` and makes it available in the native callback using the
175-
`v8::FunctionCallbackInfo::Data()` method.
172+
to `v8::FunctionTemplate::New()` or `v8::Function::New()` which creates the
173+
native-backed JavaScript functions. The third parameter of
174+
`v8::FunctionTemplate::New()` or `v8::Function::New()` accepts the
175+
`v8::External` and makes it available in the native callback using the
176+
`v8::FunctionCallbackInfo::Data()` method.
176177

177178
This will ensure that the per-addon-instance data reaches each binding that can
178179
be called from JavaScript. The per-addon-instance data must also be passed into
@@ -395,14 +396,14 @@ the appropriate headers automatically. However, there are a few caveats to be
395396
aware of:
396397

397398
* When `node-gyp` runs, it will detect the specific release version of Node.js
398-
and download either the full source tarball or just the headers. If the full
399-
source is downloaded, addons will have complete access to the full set of
400-
Node.js dependencies. However, if only the Node.js headers are downloaded, then
401-
only the symbols exported by Node.js will be available.
399+
and download either the full source tarball or just the headers. If the full
400+
source is downloaded, addons will have complete access to the full set of
401+
Node.js dependencies. However, if only the Node.js headers are downloaded,
402+
then only the symbols exported by Node.js will be available.
402403

403404
* `node-gyp` can be run using the `--nodedir` flag pointing at a local Node.js
404-
source image. Using this option, the addon will have access to the full set of
405-
dependencies.
405+
source image. Using this option, the addon will have access to the full set of
406+
dependencies.
406407

407408
### Loading addons using `require()`
408409

‎doc/api/assert.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -223,7 +223,7 @@ added: v14.2.0
223223
-->
224224

225225
* Returns: {Array} of objects containing information about the wrapper functions
226-
returned by [`tracker.calls()`][].
226+
returned by [`tracker.calls()`][].
227227
* Object {Object}
228228
* `message` {string}
229229
* `actual` {number} The actual number of times the function was called.

‎doc/api/async_hooks.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -697,14 +697,14 @@ asyncResource.triggerAsyncId();
697697
* `type` {string} The type of async event.
698698
* `options` {Object}
699699
* `triggerAsyncId` {number} The ID of the execution context that created this
700-
async event. **Default:** `executionAsyncId()`.
700+
async event. **Default:** `executionAsyncId()`.
701701
* `requireManualDestroy` {boolean} If set to `true`, disables `emitDestroy`
702-
when the object is garbage collected. This usually does not need to be set
703-
(even if `emitDestroy` is called manually), unless the resource's `asyncId`
704-
is retrieved and the sensitive API's `emitDestroy` is called with it.
705-
When set to `false`, the `emitDestroy` call on garbage collection
706-
will only take place if there is at least one active `destroy` hook.
707-
**Default:** `false`.
702+
when the object is garbage collected. This usually does not need to be set
703+
(even if `emitDestroy` is called manually), unless the resource's `asyncId`
704+
is retrieved and the sensitive API's `emitDestroy` is called with it.
705+
When set to `false`, the `emitDestroy` call on garbage collection
706+
will only take place if there is at least one active `destroy` hook.
707+
**Default:** `false`.
708708

709709
Example usage:
710710

@@ -785,7 +785,7 @@ never be called.
785785
#### `asyncResource.triggerAsyncId()`
786786

787787
* Returns: {number} The same `triggerAsyncId` that is passed to the
788-
`AsyncResource` constructor.
788+
`AsyncResource` constructor.
789789

790790
<a id="async-resource-worker-pool"></a>
791791
### Using `AsyncResource` for a `Worker` thread pool

‎doc/api/debugger.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -115,14 +115,14 @@ To begin watching an expression, type `watch('my_expression')`. The command
115115
* `setBreakpoint()`, `sb()`: Set breakpoint on current line
116116
* `setBreakpoint(line)`, `sb(line)`: Set breakpoint on specific line
117117
* `setBreakpoint('fn()')`, `sb(...)`: Set breakpoint on a first statement in
118-
functions body
118+
functions body
119119
* `setBreakpoint('script.js', 1)`, `sb(...)`: Set breakpoint on first line of
120-
`script.js`
120+
`script.js`
121121
* `setBreakpoint('script.js', 1, 'num < 4')`, `sb(...)`: Set conditional
122-
breakpoint on first line of `script.js` that only breaks when `num < 4`
123-
evaluates to `true`
122+
breakpoint on first line of `script.js` that only breaks when `num < 4`
123+
evaluates to `true`
124124
* `clearBreakpoint('script.js', 1)`, `cb(...)`: Clear breakpoint in `script.js`
125-
on line 1
125+
on line 1
126126

127127
It is also possible to set a breakpoint in a file (module) that
128128
is not loaded yet:
@@ -188,11 +188,11 @@ debug>
188188

189189
* `backtrace`, `bt`: Print backtrace of current execution frame
190190
* `list(5)`: List scripts source code with 5 line context (5 lines before and
191-
after)
191+
after)
192192
* `watch(expr)`: Add expression to watch list
193193
* `unwatch(expr)`: Remove expression from watch list
194194
* `watchers`: List all watchers and their values (automatically listed on each
195-
breakpoint)
195+
breakpoint)
196196
* `repl`: Open debugger's repl for evaluation in debugging script's context
197197
* `exec expr`: Execute an expression in debugging script's context
198198

‎doc/api/dns.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -226,13 +226,13 @@ changes:
226226
The following flags can be passed as hints to [`dns.lookup()`][].
227227

228228
* `dns.ADDRCONFIG`: Limits returned address types to the types of non-loopback
229-
addresses configured on the system. For example, IPv4 addresses are only
230-
returned if the current system has at least one IPv4 address configured.
229+
addresses configured on the system. For example, IPv4 addresses are only
230+
returned if the current system has at least one IPv4 address configured.
231231
* `dns.V4MAPPED`: If the IPv6 family was specified, but no IPv6 addresses were
232-
found, then return IPv4 mapped IPv6 addresses. It is not supported
233-
on some operating systems (e.g FreeBSD 10.1).
232+
found, then return IPv4 mapped IPv6 addresses. It is not supported
233+
on some operating systems (e.g FreeBSD 10.1).
234234
* `dns.ALL`: If `dns.V4MAPPED` is specified, return resolved IPv6 addresses as
235-
well as IPv4 mapped IPv6 addresses.
235+
well as IPv4 mapped IPv6 addresses.
236236

237237
## `dns.lookupService(address, port, callback)`
238238
<!-- YAML

‎doc/api/fs.md

+22-22
Original file line numberDiff line numberDiff line change
@@ -1678,13 +1678,13 @@ OR of two or more values (e.g.
16781678
`fs.constants.COPYFILE_EXCL | fs.constants.COPYFILE_FICLONE`).
16791679

16801680
* `fs.constants.COPYFILE_EXCL`: The copy operation will fail if `dest` already
1681-
exists.
1681+
exists.
16821682
* `fs.constants.COPYFILE_FICLONE`: The copy operation will attempt to create a
1683-
copy-on-write reflink. If the platform does not support copy-on-write, then a
1684-
fallback copy mechanism is used.
1683+
copy-on-write reflink. If the platform does not support copy-on-write, then a
1684+
fallback copy mechanism is used.
16851685
* `fs.constants.COPYFILE_FICLONE_FORCE`: The copy operation will attempt to
1686-
create a copy-on-write reflink. If the platform does not support copy-on-write,
1687-
then the operation will fail.
1686+
create a copy-on-write reflink. If the platform does not support
1687+
copy-on-write, then the operation will fail.
16881688

16891689
```js
16901690
const fs = require('fs');
@@ -1727,13 +1727,13 @@ OR of two or more values (e.g.
17271727
`fs.constants.COPYFILE_EXCL | fs.constants.COPYFILE_FICLONE`).
17281728

17291729
* `fs.constants.COPYFILE_EXCL`: The copy operation will fail if `dest` already
1730-
exists.
1730+
exists.
17311731
* `fs.constants.COPYFILE_FICLONE`: The copy operation will attempt to create a
1732-
copy-on-write reflink. If the platform does not support copy-on-write, then a
1733-
fallback copy mechanism is used.
1732+
copy-on-write reflink. If the platform does not support copy-on-write, then a
1733+
fallback copy mechanism is used.
17341734
* `fs.constants.COPYFILE_FICLONE_FORCE`: The copy operation will attempt to
1735-
create a copy-on-write reflink. If the platform does not support copy-on-write,
1736-
then the operation will fail.
1735+
create a copy-on-write reflink. If the platform does not support
1736+
copy-on-write, then the operation will fail.
17371737

17381738
```js
17391739
const fs = require('fs');
@@ -1778,7 +1778,7 @@ changes:
17781778
* `path` {string|Buffer|URL}
17791779
* `options` {string|Object}
17801780
* `flags` {string} See [support of file system `flags`][]. **Default:**
1781-
`'r'`.
1781+
`'r'`.
17821782
* `encoding` {string} **Default:** `null`
17831783
* `fd` {integer} **Default:** `null`
17841784
* `mode` {integer} **Default:** `0o666`
@@ -1881,7 +1881,7 @@ changes:
18811881
* `path` {string|Buffer|URL}
18821882
* `options` {string|Object}
18831883
* `flags` {string} See [support of file system `flags`][]. **Default:**
1884-
`'w'`.
1884+
`'w'`.
18851885
* `encoding` {string} **Default:** `'utf8'`
18861886
* `fd` {integer} **Default:** `null`
18871887
* `mode` {integer} **Default:** `0o666`
@@ -3092,11 +3092,11 @@ when possible prefer streaming via `fs.createReadStream()`.
30923092

30933093
1. Any specified file descriptor has to support reading.
30943094
2. If a file descriptor is specified as the `path`, it will not be closed
3095-
automatically.
3095+
automatically.
30963096
3. The reading will begin at the current position. For example, if the file
3097-
already had `'Hello World`' and six bytes are read with the file descriptor,
3098-
the call to `fs.readFile()` with the same file descriptor, would give
3099-
`'World'`, rather than `'Hello World'`.
3097+
already had `'Hello World`' and six bytes are read with the file descriptor,
3098+
the call to `fs.readFile()` with the same file descriptor, would give
3099+
`'World'`, rather than `'Hello World'`.
31003100

31013101
## `fs.readFileSync(path[, options])`
31023102
<!-- YAML
@@ -5135,13 +5135,13 @@ OR of two or more values (e.g.
51355135
`fs.constants.COPYFILE_EXCL | fs.constants.COPYFILE_FICLONE`).
51365136

51375137
* `fs.constants.COPYFILE_EXCL`: The copy operation will fail if `dest` already
5138-
exists.
5138+
exists.
51395139
* `fs.constants.COPYFILE_FICLONE`: The copy operation will attempt to create a
5140-
copy-on-write reflink. If the platform does not support copy-on-write, then a
5141-
fallback copy mechanism is used.
5140+
copy-on-write reflink. If the platform does not support copy-on-write, then a
5141+
fallback copy mechanism is used.
51425142
* `fs.constants.COPYFILE_FICLONE_FORCE`: The copy operation will attempt to
5143-
create a copy-on-write reflink. If the platform does not support copy-on-write,
5144-
then the operation will fail.
5143+
create a copy-on-write reflink. If the platform does not support
5144+
copy-on-write, then the operation will fail.
51455145

51465146
```js
51475147
const {
@@ -5987,7 +5987,7 @@ string.
59875987
* `'wx'`: Like `'w'` but fails if the path exists.
59885988

59895989
* `'w+'`: Open file for reading and writing.
5990-
The file is created (if it does not exist) or truncated (if it exists).
5990+
The file is created (if it does not exist) or truncated (if it exists).
59915991

59925992
* `'wx+'`: Like `'w+'` but fails if the path exists.
59935993

‎doc/api/http.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1984,9 +1984,9 @@ Duplicates in raw headers are handled in the following ways, depending on the
19841984
header name:
19851985

19861986
* Duplicates of `age`, `authorization`, `content-length`, `content-type`,
1987-
`etag`, `expires`, `from`, `host`, `if-modified-since`, `if-unmodified-since`,
1988-
`last-modified`, `location`, `max-forwards`, `proxy-authorization`, `referer`,
1989-
`retry-after`, `server`, or `user-agent` are discarded.
1987+
`etag`, `expires`, `from`, `host`, `if-modified-since`, `if-unmodified-since`,
1988+
`last-modified`, `location`, `max-forwards`, `proxy-authorization`, `referer`,
1989+
`retry-after`, `server`, or `user-agent` are discarded.
19901990
* `set-cookie` is always an array. Duplicates are added to the array.
19911991
* For duplicate `cookie` headers, the values are joined together with '; '.
19921992
* For all other headers, the values are joined together with ', '.

‎doc/api/http2.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1402,7 +1402,7 @@ added: v8.4.0
14021402
* `err` {Error}
14031403
* `pushStream` {ServerHttp2Stream} The returned `pushStream` object.
14041404
* `headers` {HTTP/2 Headers Object} Headers object the `pushStream` was
1405-
initiated with.
1405+
initiated with.
14061406

14071407
Initiates a push stream. The callback is invoked with the new `Http2Stream`
14081408
instance created for the push stream passed as the second argument, or an

‎doc/api/https.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ added: v0.3.4
161161
-->
162162

163163
* `options` {Object} Accepts `options` from [`tls.createServer()`][],
164-
[`tls.createSecureContext()`][] and [`http.createServer()`][].
164+
[`tls.createSecureContext()`][] and [`http.createServer()`][].
165165
* `requestListener` {Function} A listener to be added to the `'request'` event.
166166
* Returns: {https.Server}
167167

‎doc/api/modules.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -503,7 +503,7 @@ wrapper that looks like the following:
503503
By doing this, Node.js achieves a few things:
504504

505505
* It keeps top-level variables (defined with `var`, `const` or `let`) scoped to
506-
the module rather than the global object.
506+
the module rather than the global object.
507507
* It helps to provide some global-looking variables that are actually specific
508508
to the module, such as:
509509
* The `module` and `exports` objects that the implementor can use to export

‎doc/api/n-api.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -858,8 +858,8 @@ typedef void (*napi_async_cleanup_hook)(napi_async_cleanup_hook_handle handle,
858858
```
859859

860860
* `[in] handle`: The handle that must be passed to
861-
[`napi_remove_async_cleanup_hook`][] after completion of the asynchronous
862-
cleanup.
861+
[`napi_remove_async_cleanup_hook`][] after completion of the asynchronous
862+
cleanup.
863863
* `[in] data`: The data that was passed to [`napi_add_async_cleanup_hook`][].
864864

865865
The body of the function should initiate the asynchronous cleanup actions at the
@@ -939,7 +939,7 @@ napi_get_last_error_info(napi_env env,
939939

940940
* `[in] env`: The environment that the API is invoked under.
941941
* `[out] result`: The `napi_extended_error_info` structure with more
942-
information about the error.
942+
information about the error.
943943

944944
Returns `napi_ok` if the API succeeded.
945945

@@ -1715,7 +1715,7 @@ NAPI_EXTERN napi_status napi_add_async_cleanup_hook(
17151715
* `[in] hook`: The function pointer to call at environment teardown.
17161716
* `[in] arg`: The pointer to pass to `hook` when it gets called.
17171717
* `[out] remove_handle`: Optional handle that refers to the asynchronous cleanup
1718-
hook.
1718+
hook.
17191719

17201720
Registers `hook`, which is a function of type [`napi_async_cleanup_hook`][], as
17211721
a function to be run with the `remove_handle` and `arg` parameters once the
@@ -1748,7 +1748,7 @@ NAPI_EXTERN napi_status napi_remove_async_cleanup_hook(
17481748
```
17491749

17501750
* `[in] remove_handle`: The handle to an asynchronous cleanup hook that was
1751-
created with [`napi_add_async_cleanup_hook`][].
1751+
created with [`napi_add_async_cleanup_hook`][].
17521752

17531753
Unregisters the cleanup hook corresponding to `remove_handle`. This will prevent
17541754
the hook from being executed, unless it has already started executing.
@@ -3355,7 +3355,7 @@ napi_status napi_typeof(napi_env env, napi_value value, napi_valuetype* result)
33553355
Returns `napi_ok` if the API succeeded.
33563356

33573357
* `napi_invalid_arg` if the type of `value` is not a known ECMAScript type and
3358-
`value` is not an External value.
3358+
`value` is not an External value.
33593359

33603360
This API represents behavior similar to invoking the `typeof` Operator on
33613361
the object as defined in [Section 12.5.5][] of the ECMAScript Language
@@ -3884,11 +3884,11 @@ napi_get_all_property_names(napi_env env,
38843884
* `[in] object`: The object from which to retrieve the properties.
38853885
* `[in] key_mode`: Whether to retrieve prototype properties as well.
38863886
* `[in] key_filter`: Which properties to retrieve
3887-
(enumerable/readable/writable).
3887+
(enumerable/readable/writable).
38883888
* `[in] key_conversion`: Whether to convert numbered property keys to strings.
38893889
* `[out] result`: A `napi_value` representing an array of JavaScript values
3890-
that represent the property names of the object. [`napi_get_array_length`][] and
3891-
[`napi_get_element`][] can be used to iterate over `result`.
3890+
that represent the property names of the object. [`napi_get_array_length`][]
3891+
and [`napi_get_element`][] can be used to iterate over `result`.
38923892

38933893
Returns `napi_ok` if the API succeeded.
38943894

@@ -4920,7 +4920,7 @@ napi_status napi_check_object_type_tag(napi_env env,
49204920
* `[in] js_object`: The JavaScript object whose type tag to examine.
49214921
* `[in] type_tag`: The tag with which to compare any tag found on the object.
49224922
* `[out] result`: Whether the type tag given matched the type tag on the
4923-
object. `false` is also returned if no type tag was found on the object.
4923+
object. `false` is also returned if no type tag was found on the object.
49244924

49254925
Returns `napi_ok` if the API succeeded.
49264926

‎doc/api/report.md

+17-17
Original file line numberDiff line numberDiff line change
@@ -396,15 +396,15 @@ node --report-uncaught-exception --report-on-signal \
396396
```
397397

398398
* `--report-uncaught-exception` Enables report to be generated on
399-
un-caught exceptions. Useful when inspecting JavaScript stack in conjunction
400-
with native stack and other runtime environment data.
399+
un-caught exceptions. Useful when inspecting JavaScript stack in conjunction
400+
with native stack and other runtime environment data.
401401

402402
* `--report-on-signal` Enables report to be generated upon receiving
403-
the specified (or predefined) signal to the running Node.js process. (See below
404-
on how to modify the signal that triggers the report.) Default signal is `SIGUSR2`.
405-
Useful when a report needs to be triggered from another program.
406-
Application monitors may leverage this feature to collect report at regular
407-
intervals and plot rich set of internal runtime data to their views.
403+
the specified (or predefined) signal to the running Node.js process. (See
404+
below on how to modify the signal that triggers the report.) Default signal is
405+
`SIGUSR2`. Useful when a report needs to be triggered from another program.
406+
Application monitors may leverage this feature to collect report at regular
407+
intervals and plot rich set of internal runtime data to their views.
408408

409409
Signal based report generation is not supported in Windows.
410410

@@ -413,24 +413,24 @@ signal. However, if `SIGUSR2` is already used for other purposes, then this
413413
flag helps to change the signal for report generation and preserve the original
414414
meaning of `SIGUSR2` for the said purposes.
415415

416-
* `--report-on-fatalerror` Enables the report to be triggered on
417-
fatal errors (internal errors within the Node.js runtime, such as out of memory)
418-
that leads to termination of the application. Useful to inspect various
419-
diagnostic data elements such as heap, stack, event loop state, resource
420-
consumption etc. to reason about the fatal error.
416+
* `--report-on-fatalerror` Enables the report to be triggered on fatal errors
417+
(internal errors within the Node.js runtime, such as out of memory)
418+
that leads to termination of the application. Useful to inspect various
419+
diagnostic data elements such as heap, stack, event loop state, resource
420+
consumption etc. to reason about the fatal error.
421421

422422
* `--report-compact` Write reports in a compact format, single-line JSON, more
423-
easily consumable by log processing systems than the default multi-line format
424-
designed for human consumption.
423+
easily consumable by log processing systems than the default multi-line format
424+
designed for human consumption.
425425

426426
* `--report-directory` Location at which the report will be
427-
generated.
427+
generated.
428428

429429
* `--report-filename` Name of the file to which the report will be
430-
written.
430+
written.
431431

432432
* `--report-signal` Sets or resets the signal for report generation
433-
(not supported on Windows). Default signal is `SIGUSR2`.
433+
(not supported on Windows). Default signal is `SIGUSR2`.
434434

435435
A report can also be triggered via an API call from a JavaScript application:
436436

‎doc/api/stream.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -682,11 +682,11 @@ A [`Readable`][] stream can be in object mode or not, regardless of whether
682682
it is in flowing mode or paused mode.
683683

684684
* In flowing mode, data is read from the underlying system automatically
685-
and provided to an application as quickly as possible using events via the
686-
[`EventEmitter`][] interface.
685+
and provided to an application as quickly as possible using events via the
686+
[`EventEmitter`][] interface.
687687

688688
* In paused mode, the [`stream.read()`][stream-read] method must be called
689-
explicitly to read chunks of data from the stream.
689+
explicitly to read chunks of data from the stream.
690690

691691
All [`Readable`][] streams begin in paused mode but can be switched to flowing
692692
mode in one of the following ways:

‎doc/api/string_decoder.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ added: v0.9.3
6262
-->
6363

6464
* `buffer` {Buffer|TypedArray|DataView} A `Buffer`, or `TypedArray`, or
65-
`DataView` containing the bytes to decode.
65+
`DataView` containing the bytes to decode.
6666
* Returns: {string}
6767

6868
Returns any remaining input stored in the internal buffer as a string. Bytes
@@ -84,7 +84,7 @@ changes:
8484
-->
8585

8686
* `buffer` {Buffer|TypedArray|DataView} A `Buffer`, or `TypedArray`, or
87-
`DataView` containing the bytes to decode.
87+
`DataView` containing the bytes to decode.
8888
* Returns: {string}
8989

9090
Returns a decoded string, ensuring that any incomplete multibyte characters at

‎doc/api/tls.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -644,7 +644,7 @@ added: v0.3.2
644644
-->
645645

646646
* `callback` {Function} A listener callback that will be registered to listen
647-
for the server instance's `'close'` event.
647+
for the server instance's `'close'` event.
648648
* Returns: {tls.Server}
649649

650650
The `server.close()` method stops the server from accepting new connections.
@@ -987,8 +987,8 @@ added: v9.9.0
987987
-->
988988

989989
* Returns: {Buffer|undefined} The latest `Finished` message that has been
990-
sent to the socket as part of a SSL/TLS handshake, or `undefined` if
991-
no `Finished` message has been sent yet.
990+
sent to the socket as part of a SSL/TLS handshake, or `undefined` if
991+
no `Finished` message has been sent yet.
992992

993993
As the `Finished` messages are message digests of the complete handshake
994994
(with a total of 192 bits for TLS 1.0 and more for SSL 3.0), they can
@@ -1045,7 +1045,7 @@ certificate.
10451045
`'2A:7A:C2:DD:...'`.
10461046
* `ext_key_usage` {Array} (Optional) The extended key usage, a set of OIDs.
10471047
* `subjectaltname` {string} (Optional) A string containing concatenated names
1048-
for the subject, an alternative to the `subject` names.
1048+
for the subject, an alternative to the `subject` names.
10491049
* `infoAccess` {Array} (Optional) An array describing the AuthorityInfoAccess,
10501050
used with OCSP.
10511051
* `issuerCertificate` {Object} (Optional) The issuer certificate object. For
@@ -1111,8 +1111,8 @@ added: v9.9.0
11111111
-->
11121112

11131113
* Returns: {Buffer|undefined} The latest `Finished` message that is expected
1114-
or has actually been received from the socket as part of a SSL/TLS handshake,
1115-
or `undefined` if there is no `Finished` message so far.
1114+
or has actually been received from the socket as part of a SSL/TLS handshake,
1115+
or `undefined` if there is no `Finished` message so far.
11161116

11171117
As the `Finished` messages are message digests of the complete handshake
11181118
(with a total of 192 bits for TLS 1.0 and more for SSL 3.0), they can
@@ -1167,7 +1167,7 @@ added: v12.11.0
11671167
-->
11681168

11691169
* Returns: {Array} List of signature algorithms shared between the server and
1170-
the client in the order of decreasing preference.
1170+
the client in the order of decreasing preference.
11711171

11721172
See
11731173
[SSL_get_shared_sigalgs](https://www.openssl.org/docs/man1.1.1/man3/SSL_get_shared_sigalgs.html)
@@ -1180,8 +1180,8 @@ added: v13.10.0
11801180

11811181
* `length` {number} number of bytes to retrieve from keying material
11821182
* `label` {string} an application specific label, typically this will be a
1183-
value from the
1184-
[IANA Exporter Label Registry](https://www.iana.org/assignments/tls-parameters/tls-parameters.xhtml#exporter-labels).
1183+
value from the
1184+
[IANA Exporter Label Registry](https://www.iana.org/assignments/tls-parameters/tls-parameters.xhtml#exporter-labels).
11851185
* `context` {Buffer} Optionally provide a context.
11861186

11871187
* Returns: {Buffer} requested bytes of the keying material

‎doc/api/util.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ added: v0.11.3
7878
* `section` {string} A string identifying the portion of the application for
7979
which the `debuglog` function is being created.
8080
* `callback` {Function} A callback invoked the first time the logging function
81-
is called with a function argument that is a more optimized logging function.
81+
is called with a function argument that is a more optimized logging function.
8282
* Returns: {Function} The logging function
8383

8484
The `util.debuglog()` method is used to create a function that conditionally
@@ -1073,7 +1073,7 @@ changes:
10731073
-->
10741074

10751075
* {symbol} that can be used to declare custom promisified variants of functions,
1076-
see [Custom promisified functions][].
1076+
see [Custom promisified functions][].
10771077

10781078
In addition to being accessible through `util.promisify.custom`, this
10791079
symbol is [registered globally][global symbol registry] and can be

0 commit comments

Comments
 (0)
Please sign in to comment.