Skip to content

Commit

Permalink
doc: make minor adjustments
Browse files Browse the repository at this point in the history
PR-URL: #43175
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
Reviewed-By: Zeyu "Alex" Yang <himself65@outlook.com>
  • Loading branch information
LiviaMedeiros authored and bengl committed May 30, 2022
1 parent 6ee9fb1 commit 3082c75
Show file tree
Hide file tree
Showing 12 changed files with 13 additions and 13 deletions.
2 changes: 1 addition & 1 deletion BUILDING.md
Original file line number Diff line number Diff line change
Expand Up @@ -539,7 +539,7 @@ When modifying only the JS layer in `lib`, it is possible to externally load it
without modifying the executable:

```console
$ ./configure --node-builtin-modules-path $(pwd)
$ ./configure --node-builtin-modules-path "$(pwd)"
```

The resulting binary won't include any JS files and will try to load them from
Expand Down
2 changes: 1 addition & 1 deletion doc/api/async_context.md
Original file line number Diff line number Diff line change
Expand Up @@ -439,7 +439,7 @@ class DBQuery extends AsyncResource {
}
```

### Static method: `AsyncResource.bind(fn[, type, [thisArg]])`
### Static method: `AsyncResource.bind(fn[, type[, thisArg]])`

<!-- YAML
added:
Expand Down
2 changes: 1 addition & 1 deletion doc/api/buffer.md
Original file line number Diff line number Diff line change
Expand Up @@ -521,7 +521,7 @@ added:

The total size of the `Blob` in bytes.

### `blob.slice([start, [end, [type]]])`
### `blob.slice([start[, end[, type]]])`

<!-- YAML
added:
Expand Down
2 changes: 1 addition & 1 deletion doc/api/corepack.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ successfully retrieved.
When running outside of an existing project (for example when running
`yarn init`), Corepack will by default use predefined versions roughly
corresponding to the latest stable releases from each tool. Those versions can
be overriden by running the [`corepack prepare`][] command along with the
be overridden by running the [`corepack prepare`][] command along with the
package manager version you wish to set:

```bash
Expand Down
2 changes: 1 addition & 1 deletion doc/api/crypto.md
Original file line number Diff line number Diff line change
Expand Up @@ -2906,7 +2906,7 @@ is currently in use. Setting to true requires a FIPS build of Node.js.
This property is deprecated. Please use `crypto.setFips()` and
`crypto.getFips()` instead.

### `crypto.checkPrime(candidate[, options, [callback]])`
### `crypto.checkPrime(candidate[, options[, callback]])`

<!-- YAML
added: v15.8.0
Expand Down
2 changes: 1 addition & 1 deletion doc/api/fs.md
Original file line number Diff line number Diff line change
Expand Up @@ -556,7 +556,7 @@ changes:
added: v10.0.0
-->
* Returns: {Promise} Fufills with `undefined` upon success.
* Returns: {Promise} Fulfills with `undefined` upon success.
Request that all data for the open file descriptor is flushed to the storage
device. The specific implementation is operating system and device specific.
Expand Down
2 changes: 1 addition & 1 deletion doc/api/https.md
Original file line number Diff line number Diff line change
Expand Up @@ -462,7 +462,7 @@ const options = {
return err;
}

// Pin the public key, similar to HPKP pin-sha25 pinning
// Pin the public key, similar to HPKP pin-sha256 pinning
const pubkey256 = 'pL1+qb9HTMRZJmuC/bB/ZI9d302BYrrqiVuRyW+DGrU=';
if (sha256(cert.pubkey) !== pubkey256) {
const msg = 'Certificate verification error: ' +
Expand Down
2 changes: 1 addition & 1 deletion doc/api/stream.md
Original file line number Diff line number Diff line change
Expand Up @@ -2219,7 +2219,7 @@ result from the calculation on the previous element. It returns a promise for
the final value of the reduction.

The reducer function iterates the stream element-by-element which means that
there is no `concurrency` parameter or parallism. To perform a `reduce`
there is no `concurrency` parameter or parallelism. To perform a `reduce`
concurrently, it can be chained to the [`readable.map`][] method.

If no `initial` value is supplied the first chunk of the stream is used as the
Expand Down
2 changes: 1 addition & 1 deletion doc/contributing/collaborator-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -238,7 +238,7 @@ files also qualify as affecting the `node` binary:
* `configure`
* `configure.py`
* `Makefile`
* `vcbuilt.bat`
* `vcbuild.bat`

</details>

Expand Down
2 changes: 1 addition & 1 deletion doc/contributing/commit-queue.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ work for more complex pull requests. These are the currently known limitations
of the commit queue:

1. All commits in a pull request must either be following commit message
guidelines or be a valid [`fixup!`](https://git-scm.com/docs/git-commit#Documentation/git-commit.txt---fixupltcommitgt)
guidelines or be a valid [`fixup!`](https://git-scm.com/docs/git-commit#Documentation/git-commit.txt---fixupamendrewordltcommitgt)
commit that will be correctly handled by the [`--autosquash`](https://git-scm.com/docs/git-rebase#Documentation/git-rebase.txt---autosquash)
option
2. A CI must've ran and succeeded since the last change on the PR
Expand Down
4 changes: 2 additions & 2 deletions doc/contributing/maintaining-shared-library-support.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ Currently, shared library support has only been tested on:

## Building with shared library option

On non-Windows platoforms, Node.js is built with the shared library
On non-Windows platforms, Node.js is built with the shared library
option by adding `--shared` to the configure step. On Windows
platofrms Node.js is built with the shared library option by
platforms Node.js is built with the shared library option by
adding `dll` to the vcbuild command line.

Once built there are two key components:
Expand Down
2 changes: 1 addition & 1 deletion doc/contributing/writing-and-running-benchmarks.md
Original file line number Diff line number Diff line change
Expand Up @@ -570,5 +570,5 @@ Supported options keys are:
[git-for-windows]: https://git-scm.com/download/win
[nghttp2.org]: https://nghttp2.org
[node-benchmark-compare]: https://github.com/targos/node-benchmark-compare
[t-test]: https://en.wikipedia.org/wiki/Student%27s_t-test#Equal_or_unequal_sample_sizes.2C_unequal_variances
[t-test]: https://en.wikipedia.org/wiki/Student%27s_t-test#Equal_or_unequal_sample_sizes%2C_unequal_variances_%28sX1_%3E_2sX2_or_sX2_%3E_2sX1%29
[wrk]: https://github.com/wg/wrk

0 comments on commit 3082c75

Please sign in to comment.