Skip to content

Commit 3082c75

Browse files
LiviaMedeirosbengl
authored andcommitted
doc: make minor adjustments
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>
1 parent 6ee9fb1 commit 3082c75

12 files changed

+13
-13
lines changed

BUILDING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -539,7 +539,7 @@ When modifying only the JS layer in `lib`, it is possible to externally load it
539539
without modifying the executable:
540540

541541
```console
542-
$ ./configure --node-builtin-modules-path $(pwd)
542+
$ ./configure --node-builtin-modules-path "$(pwd)"
543543
```
544544

545545
The resulting binary won't include any JS files and will try to load them from

doc/api/async_context.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -439,7 +439,7 @@ class DBQuery extends AsyncResource {
439439
}
440440
```
441441

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

444444
<!-- YAML
445445
added:

doc/api/buffer.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -521,7 +521,7 @@ added:
521521

522522
The total size of the `Blob` in bytes.
523523

524-
### `blob.slice([start, [end, [type]]])`
524+
### `blob.slice([start[, end[, type]]])`
525525

526526
<!-- YAML
527527
added:

doc/api/corepack.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ successfully retrieved.
5757
When running outside of an existing project (for example when running
5858
`yarn init`), Corepack will by default use predefined versions roughly
5959
corresponding to the latest stable releases from each tool. Those versions can
60-
be overriden by running the [`corepack prepare`][] command along with the
60+
be overridden by running the [`corepack prepare`][] command along with the
6161
package manager version you wish to set:
6262

6363
```bash

doc/api/crypto.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2906,7 +2906,7 @@ is currently in use. Setting to true requires a FIPS build of Node.js.
29062906
This property is deprecated. Please use `crypto.setFips()` and
29072907
`crypto.getFips()` instead.
29082908

2909-
### `crypto.checkPrime(candidate[, options, [callback]])`
2909+
### `crypto.checkPrime(candidate[, options[, callback]])`
29102910

29112911
<!-- YAML
29122912
added: v15.8.0

doc/api/fs.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -556,7 +556,7 @@ changes:
556556
added: v10.0.0
557557
-->
558558
559-
* Returns: {Promise} Fufills with `undefined` upon success.
559+
* Returns: {Promise} Fulfills with `undefined` upon success.
560560
561561
Request that all data for the open file descriptor is flushed to the storage
562562
device. The specific implementation is operating system and device specific.

doc/api/https.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -462,7 +462,7 @@ const options = {
462462
return err;
463463
}
464464

465-
// Pin the public key, similar to HPKP pin-sha25 pinning
465+
// Pin the public key, similar to HPKP pin-sha256 pinning
466466
const pubkey256 = 'pL1+qb9HTMRZJmuC/bB/ZI9d302BYrrqiVuRyW+DGrU=';
467467
if (sha256(cert.pubkey) !== pubkey256) {
468468
const msg = 'Certificate verification error: ' +

doc/api/stream.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2219,7 +2219,7 @@ result from the calculation on the previous element. It returns a promise for
22192219
the final value of the reduction.
22202220

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

22252225
If no `initial` value is supplied the first chunk of the stream is used as the

doc/contributing/collaborator-guide.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -238,7 +238,7 @@ files also qualify as affecting the `node` binary:
238238
* `configure`
239239
* `configure.py`
240240
* `Makefile`
241-
* `vcbuilt.bat`
241+
* `vcbuild.bat`
242242

243243
</details>
244244

doc/contributing/commit-queue.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ work for more complex pull requests. These are the currently known limitations
5050
of the commit queue:
5151

5252
1. All commits in a pull request must either be following commit message
53-
guidelines or be a valid [`fixup!`](https://git-scm.com/docs/git-commit#Documentation/git-commit.txt---fixupltcommitgt)
53+
guidelines or be a valid [`fixup!`](https://git-scm.com/docs/git-commit#Documentation/git-commit.txt---fixupamendrewordltcommitgt)
5454
commit that will be correctly handled by the [`--autosquash`](https://git-scm.com/docs/git-rebase#Documentation/git-rebase.txt---autosquash)
5555
option
5656
2. A CI must've ran and succeeded since the last change on the PR

doc/contributing/maintaining-shared-library-support.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@ Currently, shared library support has only been tested on:
2121

2222
## Building with shared library option
2323

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

2929
Once built there are two key components:

doc/contributing/writing-and-running-benchmarks.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -570,5 +570,5 @@ Supported options keys are:
570570
[git-for-windows]: https://git-scm.com/download/win
571571
[nghttp2.org]: https://nghttp2.org
572572
[node-benchmark-compare]: https://github.com/targos/node-benchmark-compare
573-
[t-test]: https://en.wikipedia.org/wiki/Student%27s_t-test#Equal_or_unequal_sample_sizes.2C_unequal_variances
573+
[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
574574
[wrk]: https://github.com/wg/wrk

0 commit comments

Comments
 (0)