diff options
author | Michaël Zasso <targos@protonmail.com> | 2021-09-18 17:49:12 +0300 |
---|---|---|
committer | Node.js GitHub Bot <github-bot@iojs.org> | 2021-09-20 18:19:25 +0300 |
commit | 931abc085e772d3ad35de2d45b22aa4e677b702d (patch) | |
tree | 82bb30aaf93ab91cb97aa83b05bfab15c68153d2 /doc | |
parent | 4e7fe5ad599951fdc3d2363f4fcc9ea671f050d5 (diff) |
doc: fix markdown indentation in lists
PR-URL: https://github.com/nodejs/node/pull/40142
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/api/esm.md | 4 | ||||
-rw-r--r-- | doc/api/process.md | 2 | ||||
-rw-r--r-- | doc/api/tls.md | 2 | ||||
-rw-r--r-- | doc/api/tty.md | 3 | ||||
-rw-r--r-- | doc/api/vm.md | 2 |
5 files changed, 7 insertions, 6 deletions
diff --git a/doc/api/esm.md b/doc/api/esm.md index a3aa832e7c8..2ad2e690ae9 100644 --- a/doc/api/esm.md +++ b/doc/api/esm.md @@ -615,7 +615,7 @@ CommonJS modules loaded. * `defaultResolve` {Function} The Node.js default resolver. * Returns: {Object} * `format` {string|null|undefined} - `'builtin' | 'commonjs' | 'json' | 'module' | 'wasm'` + `'builtin' | 'commonjs' | 'json' | 'module' | 'wasm'` * `url` {string} The absolute url to the import target (such as `file://…`) The `resolve` hook returns the resolved file URL for a given module specifier @@ -686,7 +686,7 @@ export async function resolve(specifier, context, defaultResolve) { * `url` {string} * `context` {Object} * `format` {string|null|undefined} The format optionally supplied by the - `resolve` hook. + `resolve` hook. * `defaultLoad` {Function} * Returns: {Object} * `format` {string} diff --git a/doc/api/process.md b/doc/api/process.md index eda27917c86..f2b7ac8f99b 100644 --- a/doc/api/process.md +++ b/doc/api/process.md @@ -2596,7 +2596,7 @@ tarball. that are no longer supported). * `'Dubnium'` for the 10.x LTS line beginning with 10.13.0. * `'Erbium'` for the 12.x LTS line beginning with 12.13.0. - For other LTS Release code names, see [Node.js Changelog Archive](https://github.com/nodejs/node/blob/HEAD/doc/changelogs/CHANGELOG_ARCHIVE.md) + For other LTS Release code names, see [Node.js Changelog Archive](https://github.com/nodejs/node/blob/HEAD/doc/changelogs/CHANGELOG_ARCHIVE.md) <!-- eslint-skip --> ```js diff --git a/doc/api/tls.md b/doc/api/tls.md index 34165f9f571..6926b7cda0c 100644 --- a/doc/api/tls.md +++ b/doc/api/tls.md @@ -1493,6 +1493,7 @@ changes: or `null` to stop the negotiation process. `psk` must be compatible with the selected cipher's digest. `identity` must use UTF-8 encoding. + When negotiating TLS-PSK (pre-shared keys), this function is called with optional identity `hint` provided by the server or `null` in case of TLS 1.3 where `hint` was removed. @@ -1928,6 +1929,7 @@ changes: * Returns: {Buffer|TypedArray|DataView} pre-shared key that must either be a buffer or `null` to stop the negotiation process. Returned PSK must be compatible with the selected cipher's digest. + When negotiating TLS-PSK (pre-shared keys), this function is called with the identity provided by the client. If the return value is `null` the negotiation process will stop and an diff --git a/doc/api/tty.md b/doc/api/tty.md index 45250c61b4b..10eb874e561 100644 --- a/doc/api/tty.md +++ b/doc/api/tty.md @@ -184,8 +184,7 @@ Returns: * `1` for 2, * `4` for 16, * `8` for 256, -* `24` for 16,777,216 -colors supported. +* `24` for 16,777,216 colors supported. Use this to determine what colors the terminal supports. Due to the nature of colors in terminals it is possible to either have false positives or false diff --git a/doc/api/vm.md b/doc/api/vm.md index cff8c9b6e23..b7cde0e3b69 100644 --- a/doc/api/vm.md +++ b/doc/api/vm.md @@ -798,7 +798,7 @@ added: * `evaluateCallback` {Function} Called when the module is evaluated. * `options` * `identifier` {string} String used in stack traces. - **Default:** `'vm:module(i)'` where `i` is a context-specific ascending + **Default:** `'vm:module(i)'` where `i` is a context-specific ascending index. * `context` {Object} The [contextified][] object as returned by the `vm.createContext()` method, to compile and evaluate this `Module` in. |