From cadfefd9eee79d6004a6982872780d592ef801d7 Mon Sep 17 00:00:00 2001 From: Beni von Cheni Date: Tue, 26 Feb 2019 01:30:23 -0500 Subject: [PATCH 1/2] doc: correct typos in various docs --- doc/api/crypto.md | 4 ++-- doc/api/n-api.md | 4 ++-- doc/api/process.md | 4 ++-- doc/api/v8.md | 4 ++-- doc/guides/using-internal-errors.md | 2 +- 5 files changed, 9 insertions(+), 9 deletions(-) diff --git a/doc/api/crypto.md b/doc/api/crypto.md index 72d4bc78df9dde..7644ff7d632a22 100644 --- a/doc/api/crypto.md +++ b/doc/api/crypto.md @@ -2107,7 +2107,7 @@ otherwise `err` will be `null`. By default, the successfully generated thrown if any of the input arguments specify invalid values or types. If `digest` is `null`, `'sha1'` will be used. This behavior is deprecated, -please specify a `digest` explicitely. +please specify a `digest` explicitly. The `iterations` argument must be a number set as high as possible. The higher the number of iterations, the more secure the derived key will be, @@ -2173,7 +2173,7 @@ If an error occurs an `Error` will be thrown, otherwise the derived key will be returned as a [`Buffer`][]. If `digest` is `null`, `'sha1'` will be used. This behavior is deprecated, -please specify a `digest` explicitely. +please specify a `digest` explicitly. The `iterations` argument must be a number set as high as possible. The higher the number of iterations, the more secure the derived key will be, diff --git a/doc/api/n-api.md b/doc/api/n-api.md index 2b061167f6cf4c..e39a13c7bf42d7 100644 --- a/doc/api/n-api.md +++ b/doc/api/n-api.md @@ -377,7 +377,7 @@ typedef void (*napi_finalize)(napi_env env, #### napi_async_execute_callback Function pointer used with functions that support asynchronous -operations. Callback functions must statisfy the following signature: +operations. Callback functions must satisfy the following signature: ```C typedef void (*napi_async_execute_callback)(napi_env env, void* data); @@ -390,7 +390,7 @@ calls should be made in `napi_async_complete_callback` instead. #### napi_async_complete_callback Function pointer used with functions that support asynchronous -operations. Callback functions must statisfy the following signature: +operations. Callback functions must satisfy the following signature: ```C typedef void (*napi_async_complete_callback)(napi_env env, diff --git a/doc/api/process.md b/doc/api/process.md index 124812802f363a..d88c89b5c37ae1 100644 --- a/doc/api/process.md +++ b/doc/api/process.md @@ -1674,7 +1674,7 @@ reports for the current process. Additional documentation is available in the added: v11.8.0 --> -* `err` {Error} A custom error used for reporting the JavsScript stack. +* `err` {Error} A custom error used for reporting the JavaScript stack. * Returns: {string} Returns a JSON-formatted diagnostic report for the running process. The report's @@ -1734,7 +1734,7 @@ added: v11.8.0 should be a relative path, that will be appended to the directory specified in `process.report.setOptions`, or the current working directory of the Node.js process, if unspecified. -* `err` {Error} A custom error used for reporting the JavsScript stack. +* `err` {Error} A custom error used for reporting the JavaScript stack. * Returns: {string} Returns the filename of the generated report. diff --git a/doc/api/v8.md b/doc/api/v8.md index 92fdf867e2287c..04866d92e39854 100644 --- a/doc/api/v8.md +++ b/doc/api/v8.md @@ -224,7 +224,7 @@ if a previous write has failed. * `id` {integer} A 32-bit unsigned integer. * `arrayBuffer` {ArrayBuffer} An `ArrayBuffer` instance. -Marks an `ArrayBuffer` as havings its contents transferred out of band. +Marks an `ArrayBuffer` as having its contents transferred out of band. Pass the corresponding `ArrayBuffer` in the deserializing context to [`deserializer.transferArrayBuffer()`][]. @@ -328,7 +328,7 @@ Deserializes a JavaScript value from the buffer and returns it. * `id` {integer} A 32-bit unsigned integer. * `arrayBuffer` {ArrayBuffer|SharedArrayBuffer} An `ArrayBuffer` instance. -Marks an `ArrayBuffer` as havings its contents transferred out of band. +Marks an `ArrayBuffer` as having its contents transferred out of band. Pass the corresponding `ArrayBuffer` in the serializing context to [`serializer.transferArrayBuffer()`][] (or return the `id` from [`serializer._getSharedArrayBufferId()`][] in the case of `SharedArrayBuffer`s). diff --git a/doc/guides/using-internal-errors.md b/doc/guides/using-internal-errors.md index 77eabb4ad48dec..3fa4b943d48bcd 100644 --- a/doc/guides/using-internal-errors.md +++ b/doc/guides/using-internal-errors.md @@ -107,7 +107,7 @@ message string. A simple example is: // Test ERR_TLS_CERT_ALTNAME_INVALID assert.strictEqual( errors.message('ERR_TLS_CERT_ALTNAME_INVALID', ['altname']), - 'Hostname/IP does not match certificate\'s altnames: altname'); + 'Hostname/IP does not match certificate\'s altname: altname'); ``` In addition, there should also be tests which validate the use of the From c93161e44fbd503b06f2266d90d9d8e499a20fb7 Mon Sep 17 00:00:00 2001 From: Beni von Cheni Date: Tue, 26 Feb 2019 02:11:49 -0500 Subject: [PATCH 2/2] doc: update "altnames" in error message of using-internal-errors.md --- doc/guides/using-internal-errors.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/guides/using-internal-errors.md b/doc/guides/using-internal-errors.md index 3fa4b943d48bcd..77eabb4ad48dec 100644 --- a/doc/guides/using-internal-errors.md +++ b/doc/guides/using-internal-errors.md @@ -107,7 +107,7 @@ message string. A simple example is: // Test ERR_TLS_CERT_ALTNAME_INVALID assert.strictEqual( errors.message('ERR_TLS_CERT_ALTNAME_INVALID', ['altname']), - 'Hostname/IP does not match certificate\'s altname: altname'); + 'Hostname/IP does not match certificate\'s altnames: altname'); ``` In addition, there should also be tests which validate the use of the