1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: make minor adjustments

Browse Source 
PR-URL: https://github.com/nodejs/node/pull/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>
This commit is contained in:
Livia Medeiros 2022-05-24 17:27:17 +08:00 committed by GitHub
parent 9a3326f332
commit 38a39143d2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
12 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
BUILDING.md
View File

@ -539,7 +539,7 @@ When modifying only the JS layer in `lib`, it is possible to externally load it
without modifying the executable: without modifying the executable:
```console ```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 The resulting binary won't include any JS files and will try to load them from

2
doc/api/async_context.md
View File

@ -439,7 +439,7 @@ class DBQuery extends AsyncResource {
} }
``` ```
### Static method: `AsyncResource.bind(fn[, type, [thisArg]])` ### Static method: `AsyncResource.bind(fn[, type[, thisArg]])`
<!-- YAML <!-- YAML
added: added:

2
doc/api/buffer.md
View File

@ -521,7 +521,7 @@ added:
The total size of the `Blob` in bytes. The total size of the `Blob` in bytes.
### `blob.slice([start, [end, [type]]])` ### `blob.slice([start[, end[, type]]])`
<!-- YAML <!-- YAML
added: added:

2
doc/api/corepack.md
View File

@ -57,7 +57,7 @@ successfully retrieved.
When running outside of an existing project (for example when running When running outside of an existing project (for example when running
`yarn init`), Corepack will by default use predefined versions roughly `yarn init`), Corepack will by default use predefined versions roughly
corresponding to the latest stable releases from each tool. Those versions can 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: package manager version you wish to set:
```bash ```bash

2
doc/api/crypto.md
View File

@ -2912,7 +2912,7 @@ is currently in use. Setting to true requires a FIPS build of Node.js.
This property is deprecated. Please use `crypto.setFips()` and This property is deprecated. Please use `crypto.setFips()` and
`crypto.getFips()` instead. `crypto.getFips()` instead.
### `crypto.checkPrime(candidate[, options, [callback]])` ### `crypto.checkPrime(candidate[, options[, callback]])`
<!-- YAML <!-- YAML
added: v15.8.0 added: v15.8.0

2
doc/api/fs.md
View File

@ -556,7 +556,7 @@ changes:
added: v10.0.0 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 Request that all data for the open file descriptor is flushed to the storage
device. The specific implementation is operating system and device specific. device. The specific implementation is operating system and device specific.

2
doc/api/https.md
View File

@ -462,7 +462,7 @@ const options = {
return err; 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='; const pubkey256 = 'pL1+qb9HTMRZJmuC/bB/ZI9d302BYrrqiVuRyW+DGrU=';
if (sha256(cert.pubkey) !== pubkey256) { if (sha256(cert.pubkey) !== pubkey256) {
const msg = 'Certificate verification error: ' + const msg = 'Certificate verification error: ' +

2
doc/api/stream.md
View File

@ -2237,7 +2237,7 @@ result from the calculation on the previous element. It returns a promise for
the final value of the reduction. the final value of the reduction.
The reducer function iterates the stream element-by-element which means that 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. 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 If no `initial` value is supplied the first chunk of the stream is used as the

2
doc/contributing/collaborator-guide.md
View File

@ -238,7 +238,7 @@ files also qualify as affecting the `node` binary:
* `configure` * `configure`
* `configure.py` * `configure.py`
* `Makefile` * `Makefile`
* `vcbuilt.bat` * `vcbuild.bat`
</details> </details>

2
doc/contributing/commit-queue.md
View File

@ -50,7 +50,7 @@ work for more complex pull requests. These are the currently known limitations
of the commit queue: of the commit queue:
1. All commits in a pull request must either be following commit message 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) commit that will be correctly handled by the [`--autosquash`](https://git-scm.com/docs/git-rebase#Documentation/git-rebase.txt---autosquash)
option option
2. A CI must've ran and succeeded since the last change on the PR 2. A CI must've ran and succeeded since the last change on the PR

4
doc/contributing/maintaining-shared-library-support.md
View File

@ -21,9 +21,9 @@ Currently, shared library support has only been tested on:
## Building with shared library option ## 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 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. adding `dll` to the vcbuild command line.
Once built there are two key components: Once built there are two key components:

2
doc/contributing/writing-and-running-benchmarks.md
View File

@ -570,5 +570,5 @@ Supported options keys are:
[git-for-windows]: https://git-scm.com/download/win [git-for-windows]: https://git-scm.com/download/win
[nghttp2.org]: https://nghttp2.org [nghttp2.org]: https://nghttp2.org
[node-benchmark-compare]: https://github.com/targos/node-benchmark-compare [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 [wrk]: https://github.com/wg/wrk