Skip to content

Commit 55feb17

Browse files
VoltrexKeyvayjl9903
authored andcommitted
doc: fix typos
PR-URL: nodejs#47685 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Debadree Chatterjee <debadree333@gmail.com> Reviewed-By: Daeyeon Jeong <daeyeon.dev@gmail.com>
1 parent 37172c4 commit 55feb17

16 files changed

+26
-26
lines changed

doc/api/cli.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -269,7 +269,7 @@ the path specified by `--snapshot-blob`.
269269
```console
270270
$ echo "globalThis.foo = 'I am from the snapshot'" > snapshot.js
271271

272-
# Run snapshot.js to intialize the application and snapshot the
272+
# Run snapshot.js to initialize the application and snapshot the
273273
# state of it into snapshot.blob.
274274
$ node --snapshot-blob snapshot.blob --build-snapshot snapshot.js
275275

doc/api/diagnostics_channel.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -567,7 +567,7 @@ applied to transform the message data before it becomes the context value for
567567
the store. The prior storage context is accessible from within the transform
568568
function in cases where context linking is required.
569569

570-
The context applied to the store should be accesible in any async code which
570+
The context applied to the store should be accessible in any async code which
571571
continues from execution which began during the given function, however
572572
there are some situations in which [context loss][] may occur.
573573

@@ -956,7 +956,7 @@ channels.asyncStart.bindStore(myStore, (data) => {
956956

957957
A TracingChannel is a collection of several diagnostics\_channels representing
958958
specific points in the execution lifecycle of a single traceable action. The
959-
behaviour is split into five diagnostics\_channels consisting of `start`,
959+
behavior is split into five diagnostics\_channels consisting of `start`,
960960
`end`, `asyncStart`, `asyncEnd`, and `error`. A single traceable action will
961961
share the same event object between all events, this can be helpful for
962962
managing correlation through a weakmap.

doc/api/domain.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -212,7 +212,7 @@ If domains are in use, then all **new** `EventEmitter` objects (including
212212
Stream objects, requests, responses, etc.) will be implicitly bound to
213213
the active domain at the time of their creation.
214214

215-
Additionally, callbacks passed to lowlevel event loop requests (such as
215+
Additionally, callbacks passed to low-level event loop requests (such as
216216
to `fs.open()`, or other callback-taking methods) will automatically be
217217
bound to the active domain. If they throw, then the domain will catch
218218
the error.
@@ -409,7 +409,7 @@ specified emitter.
409409
* `...args` {any}
410410

411411
Run the supplied function in the context of the domain, implicitly
412-
binding all event emitters, timers, and lowlevel requests that are
412+
binding all event emitters, timers, and low-level requests that are
413413
created in that context. Optionally, arguments can be passed to
414414
the function.
415415

doc/api/inspector.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Create a new instance of the `inspector.Session` class. The inspector session
5454
needs to be connected through [`session.connect()`][] before the messages
5555
can be dispatched to the inspector backend.
5656

57-
When using `Session`, the object outputed by the console API will not be
57+
When using `Session`, the object outputted by the console API will not be
5858
released, unless we performed manually `Runtime.DiscardConsoleEntries`
5959
command.
6060

@@ -227,7 +227,7 @@ Create a new instance of the `inspector.Session` class. The inspector session
227227
needs to be connected through [`session.connect()`][] before the messages
228228
can be dispatched to the inspector backend.
229229

230-
When using `Session`, the object outputed by the console API will not be
230+
When using `Session`, the object outputted by the console API will not be
231231
released, unless we performed manually `Runtime.DiscardConsoleEntries`
232232
command.
233233

doc/api/n-api.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Node-API is a C API that ensures ABI stability across Node.js versions
3737
and different compiler levels. A C++ API can be easier to use.
3838
To support using C++, the project maintains a
3939
C++ wrapper module called [`node-addon-api`][].
40-
This wrapper provides an inlineable C++ API. Binaries built
40+
This wrapper provides an inlinable C++ API. Binaries built
4141
with `node-addon-api` will depend on the symbols for the Node-API C-based
4242
functions exported by Node.js. `node-addon-api` is a more
4343
efficient way to write code that calls Node-API. Take, for example, the
@@ -542,7 +542,7 @@ the call will succeed and `data` will be set to `NULL`.
542542

543543
## Basic Node-API data types
544544

545-
Node-API exposes the following fundamental datatypes as abstractions that are
545+
Node-API exposes the following fundamental data types as abstractions that are
546546
consumed by the various APIs. These APIs should be treated as opaque,
547547
introspectable only with other Node-API calls.
548548

doc/api/util.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1481,7 +1481,7 @@ console.log(values, positionals);
14811481

14821482
### `parseArgs` `tokens`
14831483

1484-
Detailed parse information is available for adding custom behaviours by
1484+
Detailed parse information is available for adding custom behaviors by
14851485
specifying `tokens: true` in the configuration.
14861486
The returned tokens have properties describing:
14871487

doc/api/wasi.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ changes:
141141
the real paths to those directories on the host machine.
142142
* `returnOnExit` {boolean} By default, when WASI applications call
143143
`__wasi_proc_exit()` `wasi.start()` will return with the exit code
144-
specified rather than terminatng the process. Setting this option to
144+
specified rather than terminating the process. Setting this option to
145145
`false` will cause the Node.js process to exit with the specified
146146
exit code instead. **Default:** `true`.
147147
* `stdin` {integer} The file descriptor used as standard input in the

doc/api/worker_threads.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1011,7 +1011,7 @@ changes:
10111011
* `stackSizeMb` {number} The default maximum stack size for the thread.
10121012
Small values may lead to unusable Worker instances. **Default:** `4`.
10131013
* `name` {string} An optional `name` to be appended to the worker title
1014-
for debuggin/identification purposes, making the final title as
1014+
for debugging/identification purposes, making the final title as
10151015
`[worker ${id}] ${name}`. **Default:** `''`.
10161016

10171017
### Event: `'error'`

doc/contributing/adding-v8-fast-api.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Node.js uses [V8](https://v8.dev/) as its JavaScript engine.
44
Embedding functions implemented in C++ incur a high overhead, so V8
55
provides an API to implement native functions which may be invoked directly
6-
from JITted code. These functions also come with additional constraints,
6+
from JIT-ed code. These functions also come with additional constraints,
77
for example, they may not trigger garbage collection.
88

99
## Limitations

doc/contributing/api-documentation.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -251,8 +251,8 @@ the new tooling.
251251
This method is responsible for parsing the `<--YAML snippets -->` and
252252
transforming them into HTML elements.
253253

254-
It follows a certain kind of "schema" that basically constitues in the following
255-
options:
254+
It follows a certain kind of "schema" that basically constitutes in the
255+
following options:
256256

257257
| YAML Key | Description | Example | Example Result | Available on new tooling |
258258
| ------------- | ------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------- | --------------------------- | ------------------------ |

doc/contributing/investigating-native-memory-leaks.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ with the output being:
4747
user1@minikube1:~/valgrind/node-addon-examples/1_hello_world/napi$ valgrind node test.js
4848
==28993== Memcheck, a memory error detector
4949
==28993== Copyright (C) 2002-2017, and GNU GPL'd, by Julian Seward et al.
50-
==28993== Using valgrind-3.13.0 and LibVEX; rerun with -h for copyright info
50+
==28993== Using Valgrind-3.13.0 and LibVEX; rerun with -h for copyright info
5151
==28993== Command: node test.js
5252
==28993==
5353
==28993== Use of uninitialised value of size 8
@@ -139,7 +139,7 @@ Running Valgrind on this code shows the following:
139139
user1@minikube1:~/valgrind/node-addon-examples/1_hello_world/napi$ valgrind node hello.js
140140
==1504== Memcheck, a memory error detector
141141
==1504== Copyright (C) 2002-2017, and GNU GPL'd, by Julian Seward et al.
142-
==1504== Using V#algrind-3.13.0 and LibVEX; rerun with -h for copyright info
142+
==1504== Using Valgrind-3.13.0 and LibVEX; rerun with -h for copyright info
143143
==1504== Command: node hello.js
144144
==1504==
145145
==1504== Use of uninitialised value of size 8

doc/contributing/maintaining-cjs-module-lexer.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ inclusion in the `deps_files` entry in
2222
The two different versions of lexer.js are maintained in the
2323
[nodejs/cjs-module-lexer][] project.
2424

25-
In order to update the Node.js dependencies to use to a newer verion
25+
In order to update the Node.js dependencies to use to a newer version
2626
of cjs-module-lexer, complete the following steps:
2727

2828
* Clone [nodejs/cjs-module-lexer][]

doc/contributing/maintaining-dependencies.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -90,12 +90,12 @@ can be added by:
9090
the new option by running `./configure --help`.
9191

9292
* adding a call to `AddExternalizedBuiltin` to the constructor
93-
for BuildinLoader in `src/node_builtins.cc` for the
93+
for BuiltinLoader in `src/node_builtins.cc` for the
9494
dependency using the `NODE_SHARED_BUILTLIN` #define generated for
9595
the dependency. After running `./configure` with the new
9696
option you can find the #define in `config.gypi`. You can cut and
9797
paste one of the existing entries and then update to match the
98-
inport name for the dependency and the #define generated.
98+
import name for the dependency and the #define generated.
9999

100100
## Supporting non-externalized dependencies with JavaScript code
101101

doc/contributing/maintaining-types-for-nodejs.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ Some additional specifics around the current approach include:
7979
the ability to provide different configurations for user-defined
8080
conditions.
8181
* There is no plan to define a default tsconfig.json for all Node.js users
82-
* We don't have consensus on provding an opinionated default but
82+
* We don't have consensus on providing an opinionated default but
8383
that should be explored after the initial steps are complete.
8484
* It will be important that as part of the messaging around this
8585
functionality that we avoid confusion that could lead people to ship

doc/contributing/releases.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -230,7 +230,7 @@ $ git push upstream v1.x-staging
230230
<summary>Security release</summary>
231231

232232
Security releases with private patches need to be prepared in the `nodejs-private`
233-
GitHub organisation.
233+
GitHub organization.
234234

235235
Add the `nodejs-private` remote:
236236

@@ -252,7 +252,7 @@ The list of patches to include should be listed in the "Next Security Release"
252252
issue in `nodejs-private`. Ask the security release steward if you're unsure.
253253

254254
The `git node land` tool does not work with the `nodejs-private`
255-
organisation. To land a PR in Node.js private, use `git cherry-pick` to apply
255+
organization. To land a PR in Node.js private, use `git cherry-pick` to apply
256256
each commit from the PR. You will also need to manually apply the PR
257257
metadata (`PR-URL`, `Reviewed-by`, etc.) by amending the commit messages. If
258258
known, additionally include `CVE-ID: CVE-XXXX-XXXXX` in the commit metadata.
@@ -373,7 +373,7 @@ all.
373373

374374
For security releases, it is necessary to include more detailed information
375375
including which vulnerabilities have been fixed, and any revert flags or
376-
workarounds to revert to the old behaviour.
376+
workarounds to revert to the old behavior.
377377

378378
You can use the following template as a guide:
379379

@@ -751,7 +751,7 @@ $ git push upstream v1.x-staging
751751
<summary>Security release</summary>
752752

753753
For security releases, you can start merging the release in the `nodejs-private`
754-
GitHub organisation in advance by following the same steps:
754+
GitHub organization in advance by following the same steps:
755755

756756
```console
757757
$ git checkout v1.x

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -292,7 +292,7 @@ module, you can use the `--filter` option:_
292292
--no-progress don't show benchmark progress indicator
293293
```
294294

295-
For analysing the benchmark results, use [node-benchmark-compare][] or the R
295+
For analyzing the benchmark results, use [node-benchmark-compare][] or the R
296296
script `benchmark/compare.R`.
297297

298298
```console

0 commit comments

Comments
 (0)