From 9bb3fdbb62766468cdb7759a77614910fe6d14a2 Mon Sep 17 00:00:00 2001 From: apeltop Date: Mon, 28 Feb 2022 01:02:42 +0900 Subject: [PATCH 1/6] doc: fix typos --- doc/api/esm.md | 2 +- doc/api/perf_hooks.md | 2 +- doc/api/policy.md | 3 +-- doc/api/process.md | 2 +- doc/api/readline.md | 2 +- doc/api/tls.md | 2 +- doc/api/vm.md | 2 +- doc/api/zlib.md | 2 +- doc/contributing/maintaining-openssl.md | 2 +- doc/contributing/pull-requests.md | 2 +- doc/contributing/static-analysis.md | 2 +- 11 files changed, 11 insertions(+), 12 deletions(-) diff --git a/doc/api/esm.md b/doc/api/esm.md index 122fddc4854d8c..c4bed1c690df2d 100644 --- a/doc/api/esm.md +++ b/doc/api/esm.md @@ -1010,7 +1010,7 @@ prints the current version of CoffeeScript per the module at the URL in Sources that are in formats Node.js doesn’t understand can be converted into JavaScript using the [`load` hook][load hook]. Before that hook gets called, -however, a [`resolve` hook][resolve hook] hook needs to tell Node.js not to +however, a [`resolve` hook][resolve hook] needs to tell Node.js not to throw an error on unknown file types. This is less performant than transpiling source files before running diff --git a/doc/api/perf_hooks.md b/doc/api/perf_hooks.md index ea6ffbef53689d..5a9913de2ff813 100644 --- a/doc/api/perf_hooks.md +++ b/doc/api/perf_hooks.md @@ -1063,7 +1063,7 @@ The minimum recorded event loop delay. added: v11.10.0 --> -* `percentile` {number} A percentile value in the range (0, 100]. +* `percentile` {number} A percentile value in the range (0, 100). * Returns: {number} Returns the value at the given percentile. diff --git a/doc/api/policy.md b/doc/api/policy.md index 0d53352788a32c..69ad931521a9a4 100644 --- a/doc/api/policy.md +++ b/doc/api/policy.md @@ -111,8 +111,7 @@ To generate integrity strings, a script such as `node -e 'process.stdout.write("sha256-");process.stdin.pipe(crypto.createHash("sha256").setEncoding("base64")).pipe(process.stdout)' < FILE` can be used. -Integrity can be specified as the boolean value `true` to accept any -body for the resource which can be useful for local development. It is not +Integrity can be specified as the boolean value `true` to accept anybody for the resource which can be useful for local development. It is not recommended in production since it would allow unexpected alteration of resources to be considered valid. diff --git a/doc/api/process.md b/doc/api/process.md index 38ba85dbc41b9b..fe5dc483493f30 100644 --- a/doc/api/process.md +++ b/doc/api/process.md @@ -3540,7 +3540,7 @@ Synchronous writes avoid problems such as output written with `console.log()` or _**Warning**_: Synchronous writes block the event loop until the write has completed. This can be near instantaneous in the case of output to a file, but under high system load, pipes that are not being read at the receiving end, or -with slow terminals or file systems, its possible for the event loop to be +with slow terminals or file systems, it's possible for the event loop to be blocked often enough and long enough to have severe negative performance impacts. This may not be a problem when writing to an interactive terminal session, but consider this particularly careful when doing production logging to diff --git a/doc/api/readline.md b/doc/api/readline.md index 0ae536ac302715..636dbc7a7a78de 100644 --- a/doc/api/readline.md +++ b/doc/api/readline.md @@ -1343,7 +1343,7 @@ const { createInterface } = require('readline'); Ctrl+E - Go to to end of line + Go to end of line diff --git a/doc/api/tls.md b/doc/api/tls.md index 0402bdcd97ebcc..d082ed3c80587a 100644 --- a/doc/api/tls.md +++ b/doc/api/tls.md @@ -228,7 +228,7 @@ To use session tickets across server restarts or load balancers, servers must all have the same ticket keys. There are three 16-byte keys internally, but the tls API exposes them as a single 48-byte buffer for convenience. -Its possible to get the ticket keys by calling [`server.getTicketKeys()`][] on +It's possible to get the ticket keys by calling [`server.getTicketKeys()`][] on one server instance and then distribute them, but it is more reasonable to securely generate 48 bytes of secure random data and set them with the `ticketKeys` option of [`tls.createServer()`][]. The keys should be regularly diff --git a/doc/api/vm.md b/doc/api/vm.md index cbb16c602ee71c..2853944eaf6fb9 100644 --- a/doc/api/vm.md +++ b/doc/api/vm.md @@ -1053,7 +1053,7 @@ current V8 isolate, or the main context. * `options` {Object} Optional. * `mode` {string} Either `'summary'` or `'detailed'`. In summary mode, only the memory measured for the main context will be returned. In - detailed mode, the measure measured for all contexts known to the + detailed mode, the measured for all contexts known to the current V8 isolate will be returned. **Default:** `'summary'` * `execution` {string} Either `'default'` or `'eager'`. With default diff --git a/doc/api/zlib.md b/doc/api/zlib.md index 77e19cb4d5cf22..0b1a7cc7ca47ba 100644 --- a/doc/api/zlib.md +++ b/doc/api/zlib.md @@ -117,7 +117,7 @@ for (let i = 0; i < 30000; ++i) { In the preceding example, 30,000 deflate instances are created concurrently. Because of how some operating systems handle memory allocation and -deallocation, this may lead to to significant memory fragmentation. +deallocation, this may lead to significant memory fragmentation. It is strongly recommended that the results of compression operations be cached to avoid duplication of effort. diff --git a/doc/contributing/maintaining-openssl.md b/doc/contributing/maintaining-openssl.md index 25a58e2f440cc5..76fcec9ee9e2d8 100644 --- a/doc/contributing/maintaining-openssl.md +++ b/doc/contributing/maintaining-openssl.md @@ -25,7 +25,7 @@ Details on the fork, as well as the latest sources, can be found at . Branches are used per OpenSSL version (for instance, -. +). ## Requirements diff --git a/doc/contributing/pull-requests.md b/doc/contributing/pull-requests.md index bc0d072484897f..6c54b6eee581c2 100644 --- a/doc/contributing/pull-requests.md +++ b/doc/contributing/pull-requests.md @@ -437,7 +437,7 @@ check with the contributor to see if they intend to continue the work before checking if they would mind if you took it over (especially if it just has nits left). When doing so, it is courteous to give the original contributor credit for the work they started (either by preserving their name and email -address in the commit log, or by using an `Author:` meta-data tag in the +address) in the commit log, or by using an `Author:` meta-data tag in the commit. ### Approving a change diff --git a/doc/contributing/static-analysis.md b/doc/contributing/static-analysis.md index 6c4a03883c7caf..46ee0c3649f873 100644 --- a/doc/contributing/static-analysis.md +++ b/doc/contributing/static-analysis.md @@ -13,4 +13,4 @@ titled `Please add me to coverity`. A member of the build WG with admin access will verify that the requestor is an existing collaborator as listed in the [collaborators section](https://github.com/nodejs/node#collaborators) on the nodejs/node project repo. Once validated the requestor will added -to to the coverity project. +to the coverity project. From 6ab029c58174db992eff3b2f5dd8ac9e88ac0376 Mon Sep 17 00:00:00 2001 From: apeltop Date: Mon, 28 Feb 2022 01:50:08 +0900 Subject: [PATCH 2/6] doc: fix by lint --- doc/api/policy.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/doc/api/policy.md b/doc/api/policy.md index 69ad931521a9a4..c50e0242455ea7 100644 --- a/doc/api/policy.md +++ b/doc/api/policy.md @@ -111,7 +111,8 @@ To generate integrity strings, a script such as `node -e 'process.stdout.write("sha256-");process.stdin.pipe(crypto.createHash("sha256").setEncoding("base64")).pipe(process.stdout)' < FILE` can be used. -Integrity can be specified as the boolean value `true` to accept anybody for the resource which can be useful for local development. It is not +Integrity can be specified as the boolean value `true` to accept anybody +for the resource which can be useful for local development. It is not recommended in production since it would allow unexpected alteration of resources to be considered valid. From b97551bdf9b90eb96d01e4138decb94f1429b08f Mon Sep 17 00:00:00 2001 From: apeltop Date: Mon, 28 Feb 2022 01:54:15 +0900 Subject: [PATCH 3/6] doc: add a word Co-authored-by: mscdex --- doc/api/vm.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/api/vm.md b/doc/api/vm.md index 2853944eaf6fb9..1938b9008afeb4 100644 --- a/doc/api/vm.md +++ b/doc/api/vm.md @@ -1053,7 +1053,7 @@ current V8 isolate, or the main context. * `options` {Object} Optional. * `mode` {string} Either `'summary'` or `'detailed'`. In summary mode, only the memory measured for the main context will be returned. In - detailed mode, the measured for all contexts known to the + detailed mode, the memory measured for all contexts known to the current V8 isolate will be returned. **Default:** `'summary'` * `execution` {string} Either `'default'` or `'eager'`. With default From ee31d446d608b6ff69d275e26b76d2f21aaf8d9f Mon Sep 17 00:00:00 2001 From: apeltop Date: Mon, 28 Feb 2022 02:44:24 +0900 Subject: [PATCH 4/6] doc: changed it to the original version. --- doc/api/policy.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/api/policy.md b/doc/api/policy.md index c50e0242455ea7..0d53352788a32c 100644 --- a/doc/api/policy.md +++ b/doc/api/policy.md @@ -111,8 +111,8 @@ To generate integrity strings, a script such as `node -e 'process.stdout.write("sha256-");process.stdin.pipe(crypto.createHash("sha256").setEncoding("base64")).pipe(process.stdout)' < FILE` can be used. -Integrity can be specified as the boolean value `true` to accept anybody -for the resource which can be useful for local development. It is not +Integrity can be specified as the boolean value `true` to accept any +body for the resource which can be useful for local development. It is not recommended in production since it would allow unexpected alteration of resources to be considered valid. From 9ddfc6be789819b9e8162ebb20a758609e0ebe61 Mon Sep 17 00:00:00 2001 From: apeltop Date: Mon, 28 Feb 2022 12:10:02 +0900 Subject: [PATCH 5/6] doc: change expression by percentile validation Co-authored-by: Danielle Adams <6271256+danielleadams@users.noreply.github.com> --- doc/api/perf_hooks.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/api/perf_hooks.md b/doc/api/perf_hooks.md index 5a9913de2ff813..ea6ffbef53689d 100644 --- a/doc/api/perf_hooks.md +++ b/doc/api/perf_hooks.md @@ -1063,7 +1063,7 @@ The minimum recorded event loop delay. added: v11.10.0 --> -* `percentile` {number} A percentile value in the range (0, 100). +* `percentile` {number} A percentile value in the range (0, 100]. * Returns: {number} Returns the value at the given percentile. From e7b170c8a4a3f3686f9530ba211c3d5fb43ce881 Mon Sep 17 00:00:00 2001 From: apeltop Date: Mon, 28 Feb 2022 12:11:29 +0900 Subject: [PATCH 6/6] doc: change expression by percentile validation --- doc/api/perf_hooks.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/api/perf_hooks.md b/doc/api/perf_hooks.md index ea6ffbef53689d..58f3bb8259195f 100644 --- a/doc/api/perf_hooks.md +++ b/doc/api/perf_hooks.md @@ -1076,7 +1076,7 @@ added: - v16.14.0 --> -* `percentile` {number} A percentile value in the range (0, 100). +* `percentile` {number} A percentile value in the range (0, 100]. * Returns: {bigint} Returns the value at the given percentile.