From 3082c75efd5dc12611347668a551a21d0159cd92 Mon Sep 17 00:00:00 2001 From: Livia Medeiros <74449973+LiviaMedeiros@users.noreply.github.com> Date: Tue, 24 May 2022 17:27:17 +0800 Subject: [PATCH] doc: make minor adjustments MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit PR-URL: https://github.com/nodejs/node/pull/43175 Reviewed-By: Antoine du Hamel Reviewed-By: Darshan Sen Reviewed-By: Tobias Nießen Reviewed-By: Matteo Collina Reviewed-By: Rich Trott Reviewed-By: Luigi Pinca Reviewed-By: Mohammed Keyvanzadeh Reviewed-By: Zeyu "Alex" Yang --- BUILDING.md | 2 +- doc/api/async_context.md | 2 +- doc/api/buffer.md | 2 +- doc/api/corepack.md | 2 +- doc/api/crypto.md | 2 +- doc/api/fs.md | 2 +- doc/api/https.md | 2 +- doc/api/stream.md | 2 +- doc/contributing/collaborator-guide.md | 2 +- doc/contributing/commit-queue.md | 2 +- doc/contributing/maintaining-shared-library-support.md | 4 ++-- doc/contributing/writing-and-running-benchmarks.md | 2 +- 12 files changed, 13 insertions(+), 13 deletions(-) diff --git a/BUILDING.md b/BUILDING.md index 79094ebaf90f5f..1e36403f53e454 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -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 diff --git a/doc/api/async_context.md b/doc/api/async_context.md index 1720c0bbad8940..8f79c7364485c1 100644 --- a/doc/api/async_context.md +++ b/doc/api/async_context.md @@ -439,7 +439,7 @@ class DBQuery extends AsyncResource { } ``` -### Static method: `AsyncResource.bind(fn[, type, [thisArg]])` +### Static method: `AsyncResource.bind(fn[, type[, thisArg]])` -* 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. diff --git a/doc/api/https.md b/doc/api/https.md index 00d5e8b3edffe9..bc5c8a246dcdf4 100644 --- a/doc/api/https.md +++ b/doc/api/https.md @@ -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: ' + diff --git a/doc/api/stream.md b/doc/api/stream.md index 2b38f44d6a895b..15c4e87e093566 100644 --- a/doc/api/stream.md +++ b/doc/api/stream.md @@ -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 diff --git a/doc/contributing/collaborator-guide.md b/doc/contributing/collaborator-guide.md index 546e0e71ba1372..05b02f02192b03 100644 --- a/doc/contributing/collaborator-guide.md +++ b/doc/contributing/collaborator-guide.md @@ -238,7 +238,7 @@ files also qualify as affecting the `node` binary: * `configure` * `configure.py` * `Makefile` -* `vcbuilt.bat` +* `vcbuild.bat` diff --git a/doc/contributing/commit-queue.md b/doc/contributing/commit-queue.md index edb9c7ad4a877f..92047ade50ab9e 100644 --- a/doc/contributing/commit-queue.md +++ b/doc/contributing/commit-queue.md @@ -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 diff --git a/doc/contributing/maintaining-shared-library-support.md b/doc/contributing/maintaining-shared-library-support.md index 45d0bc279673f0..a2e0e4d4805d1f 100644 --- a/doc/contributing/maintaining-shared-library-support.md +++ b/doc/contributing/maintaining-shared-library-support.md @@ -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: diff --git a/doc/contributing/writing-and-running-benchmarks.md b/doc/contributing/writing-and-running-benchmarks.md index e61b5ea898c7de..bab0cc1c2fa928 100644 --- a/doc/contributing/writing-and-running-benchmarks.md +++ b/doc/contributing/writing-and-running-benchmarks.md @@ -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