Skip to content

Commit 1314579

Browse files
authored
doc: fix typos in documentation
Fix typographical errors in API, contributor, and crypto docs. Signed-off-by: sjungwon03 <sjungwon03@gmail.com> PR-URL: #64466 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Marco Ippolito <marcoippolito54@gmail.com> Reviewed-By: Jacob Smith <jacob@frende.me>
1 parent 384d7a4 commit 1314579

8 files changed

Lines changed: 11 additions & 11 deletions

File tree

doc/api/deprecations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4564,7 +4564,7 @@ The `module.register()` API provides off-thread async hooks for customizing ES m
45644564
the `module.registerHooks()` API provides similar hooks that are synchronous, in-thread, and
45654565
work for all types of modules.
45664566
Supporting async hooks has proven to be complex, involving worker threads orchestration, and there are issues
4567-
that have proven unresolveable. See [caveats of asynchronous customization hooks][]. Please migrate to
4567+
that have proven unresolvable. See [caveats of asynchronous customization hooks][]. Please migrate to
45684568
`module.registerHooks()` as soon as possible as `module.register()` will be
45694569
removed in a future version of Node.js.
45704570

doc/api/errors.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3441,7 +3441,7 @@ import 'package-name'; // supported
34413441
added: v22.6.0
34423442
-->
34433443

3444-
Type stripping is not supported for files descendent of a `node_modules` directory.
3444+
Type stripping is not supported for files descendant of a `node_modules` directory.
34453445

34463446
<a id="ERR_UNSUPPORTED_RESOLVE_REQUEST"></a>
34473447

doc/api/n-api.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4329,7 +4329,7 @@ napi_status napi_strict_equals(napi_env env,
43294329
Returns `napi_ok` if the API succeeded.
43304330

43314331
This API represents the invocation of the Strict Equality algorithm as
4332-
defined in [Section IsStrctEqual][] of the ECMAScript Language Specification.
4332+
defined in [Section IsStrictlyEqual][] of the ECMAScript Language Specification.
43334333

43344334
### `napi_detach_arraybuffer`
43354335

@@ -4636,7 +4636,7 @@ They can be one or more of the following bit flags:
46364636
opposed to an instance property, which is the default. This is used only by
46374637
[`napi_define_class`][]. It is ignored by `napi_define_properties`.
46384638
* `napi_default_method`: Like a method in a JS class, the property is
4639-
configurable and writeable, but not enumerable.
4639+
configurable and writable, but not enumerable.
46404640
* `napi_default_jsproperty`: Like a property set via assignment in JavaScript,
46414641
the property is writable, enumerable, and configurable.
46424642

@@ -6986,7 +6986,7 @@ the add-on's file name during loading.
69866986
[Section DefineOwnProperty]: https://tc39.es/ecma262/#sec-ordinary-object-internal-methods-and-internal-slots-defineownproperty-p-desc
69876987
[Section Function objects]: https://tc39.es/ecma262/#sec-function-objects
69886988
[Section IsArray]: https://tc39.es/ecma262/#sec-isarray
6989-
[Section IsStrctEqual]: https://tc39.es/ecma262/#sec-strict-equality-comparison
6989+
[Section IsStrictlyEqual]: https://tc39.es/ecma262/#sec-strict-equality-comparison
69906990
[Section Promise objects]: https://tc39.es/ecma262/#sec-promise-objects
69916991
[Section SharedArrayBuffer objects]: https://tc39.es/ecma262/#sec-sharedarraybuffer-objects
69926992
[Section ToBoolean]: https://tc39.es/ecma262/#sec-toboolean

doc/api/stream.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3552,7 +3552,7 @@ changes:
35523552
* `stream` {Stream|ReadableStream|WritableStream} A stream to attach a signal
35533553
to.
35543554

3555-
Attaches an AbortSignal to a readable or writeable stream. This lets code
3555+
Attaches an AbortSignal to a readable or writable stream. This lets code
35563556
control stream destruction using an `AbortController`.
35573557

35583558
Calling `abort` on the `AbortController` corresponding to the passed
@@ -3844,7 +3844,7 @@ const myWritable = new Writable({
38443844

38453845
Calling `abort` on the `AbortController` corresponding to the passed
38463846
`AbortSignal` will behave the same way as calling `.destroy(new AbortError())`
3847-
on the writeable stream.
3847+
on the writable stream.
38483848

38493849
```js
38503850
const { Writable } = require('node:stream');

doc/contributing/advocacy-ambassador-program.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@ Some of the things to highlight include:
196196
time we all have other responsibilities that affect how much time we have
197197
available to do so.
198198
* People are volunteering their time to review your PRs and answer questions in
199-
the issues you open. Be mindfull of your asks for their time and acknowledge
199+
the issues you open. Be mindful of your asks for their time and acknowledge
200200
the gift of their time. Too many issues/PRs in a short period of time may
201201
overwhelm maintainers leading to less progress versus more, try to pace your
202202
issues and PRs so that you don't have too many open at the same time. The

doc/contributing/issues.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ activities, such as applying labels and closing/reopening/assigning issues.
6060
For more information on the roles and permissions, see ["Permission levels for
6161
repositories owned by an organization"](https://docs.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization).
6262

63-
When triagging issues and PRs:
63+
When triaging issues and PRs:
6464

6565
* Show patience and empathy, especially to first-time contributors.
6666
* Show no patience towards spam or troll, close the issue without interacting with it and

doc/contributing/maintaining/maintaining-dependencies.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ dependencies.
167167

168168
The container provides a durable copy of the versions of the tools
169169
used for a specific build which are under the control of the Node.js
170-
project. In addition, the tools and verions are documented through metadata
170+
project. In addition, the tools and versions are documented through metadata
171171
within the container in the `/home/node/metadata directory`.
172172

173173
The available tools can be found by looking at the current version of the

src/crypto/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Welcome. You've found your way to the Node.js native crypto subsystem.
44

55
Do not be afraid.
66

7-
While crypto may be a dark, mysterious, and forboding subject; and while
7+
While crypto may be a dark, mysterious, and foreboding subject; and while
88
this directory may be filled with many `*.h` and `*.cc` files, finding
99
your way around is not too difficult. And I can promise you that a Gru
1010
will not jump out of the shadows and eat you (well, "promise" may be a

0 commit comments

Comments
 (0)