From 0254b4b0d34e38537c5f271e2cb87693ac7c1452 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C3=ABl=20Zasso?= Date: Sat, 18 Sep 2021 16:49:12 +0200 Subject: [PATCH] doc: fix markdown indentation in lists MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit PR-URL: https://github.com/nodejs/node/pull/40142 Reviewed-By: Luigi Pinca Reviewed-By: Tobias Nießen Reviewed-By: Rich Trott Reviewed-By: Darshan Sen Reviewed-By: Colin Ihrig Reviewed-By: James M Snell --- doc/api/process.md | 2 +- doc/api/tls.md | 2 ++ doc/api/tty.md | 3 +-- doc/api/vm.md | 2 +- 4 files changed, 5 insertions(+), 4 deletions(-) diff --git a/doc/api/process.md b/doc/api/process.md index 3243b23da555a3..806bb66685ce67 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) ```js diff --git a/doc/api/tls.md b/doc/api/tls.md index 2b4c6bf111f3da..18819287a349ee 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 df050c8ae9e96f..2a978c081f7854 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 49297ada3c65e9..586e1f7bedea6c 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.