Skip to content

doc: correct typos in various docs #26312

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.

Sign up for GitHub

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

Closed
BeniCheni wants to merge 2 commits into from
Closed

doc: correct typos in various docs #26312

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cadfefd
doc: correct typos in various docs
BeniCheni Feb 26, 2019
c93161e
doc: update "altnames" in error message of using-internal-errors.md
BeniCheni Feb 26, 2019
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
Next Next commit
doc: correct typos in various docs
  • Loading branch information
@BeniCheni
BeniCheni committed Feb 26, 2019
commit cadfefd9eee79d6004a6982872780d592ef801d7
4 changes: 2 additions & 2 deletions doc/api/crypto.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down Expand Up @@ -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,
Expand Down
4 changes: 2 additions & 2 deletions doc/api/n-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand All @@ -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,
Expand Down
4 changes: 2 additions & 2 deletions doc/api/process.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.

Expand Down
4 changes: 2 additions & 2 deletions doc/api/v8.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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()`][].

Expand Down Expand Up @@ -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).
Expand Down
2 changes: 1 addition & 1 deletion doc/guides/using-internal-errors.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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');
Comment thread
BeniCheni marked this conversation as resolved.
Outdated
```

In addition, there should also be tests which validate the use of the
Expand Down