Skip to content

Commit 84b698d

Browse files
tniessenjuanarbol
authored andcommitted
doc: use ASCII apostrophes consistently
PR-URL: #43114 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Darshan Sen <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Mohammed Keyvanzadeh <[email protected]>
1 parent c3ae514 commit 84b698d

18 files changed

+66
-66
lines changed

SECURITY.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
Report security bugs in Node.js via [HackerOne](https://hackerone.com/nodejs).
66

7-
Your report will be acknowledged within 5 days, and youll receive a more
7+
Your report will be acknowledged within 5 days, and you'll receive a more
88
detailed response to your report within 10 days indicating the next steps in
99
handling your submission.
1010

@@ -49,7 +49,7 @@ Here is the security disclosure policy for Node.js
4949

5050
* This process can take some time, especially when coordination is required
5151
with maintainers of other projects. Every effort will be made to handle the
52-
bug in as timely a manner as possible; however, its important that we follow
52+
bug in as timely a manner as possible; however, it's important that we follow
5353
the release process above to ensure that the disclosure is handled in a
5454
consistent manner.
5555

doc/api/buffer.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -316,7 +316,7 @@ console.log(uint16array);
316316
```
317317

318318
It is possible to create a new `Buffer` that shares the same allocated
319-
memory as a [`TypedArray`][] instance by using the `TypedArray` objects
319+
memory as a [`TypedArray`][] instance by using the `TypedArray` object's
320320
`.buffer` property in the same way. [`Buffer.from()`][`Buffer.from(arrayBuf)`]
321321
behaves like `new Uint8Array()` in this context.
322322

doc/api/console.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -408,7 +408,7 @@ added: v10.0.0
408408

409409
Try to construct a table with the columns of the properties of `tabularData`
410410
(or use `properties`) and rows of `tabularData` and log it. Falls back to just
411-
logging the argument if it cant be parsed as tabular.
411+
logging the argument if it can't be parsed as tabular.
412412

413413
```js
414414
// These can't be parsed as tabular data
@@ -459,7 +459,7 @@ changes:
459459
description: The elapsed time is displayed with a suitable time unit.
460460
- version: v6.0.0
461461
pr-url: https://github.com/nodejs/node/pull/5901
462-
description: This method no longer supports multiple calls that dont map
462+
description: This method no longer supports multiple calls that don't map
463463
to individual `console.time()` calls; see below for details.
464464
-->
465465

doc/api/deprecations.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2574,7 +2574,7 @@ changes:
25742574
Type: Runtime
25752575

25762576
Passing a callback to [`worker.terminate()`][] is deprecated. Use the returned
2577-
`Promise` instead, or a listener to the workers `'exit'` event.
2577+
`Promise` instead, or a listener to the worker's `'exit'` event.
25782578

25792579
### DEP0133: `http` `connection`
25802580

doc/api/esm.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ algorithm][]. All other specifier resolutions are always only resolved with
141141
the standard relative [URL][] resolution semantics.
142142

143143
Like in CommonJS, module files within packages can be accessed by appending a
144-
path to the package name unless the packages [`package.json`][] contains an
144+
path to the package name unless the package's [`package.json`][] contains an
145145
[`"exports"`][] field, in which case files within packages can only be accessed
146146
via the paths defined in [`"exports"`][].
147147

@@ -711,7 +711,7 @@ Hooks are part of a chain, even if that chain consists of only one custom
711711
(user-provided) hook and the default hook, which is always present. Hook
712712
functions nest: each one must always return a plain object, and chaining happens
713713
as a result of each function calling `next<hookName>()`, which is a reference
714-
to the subsequent loaders hook.
714+
to the subsequent loader's hook.
715715
716716
A hook that returns a value lacking a required property triggers an exception.
717717
A hook that returns without calling `next<hookName>()` _and_ without returning
@@ -981,7 +981,7 @@ export function globalPreload({ port }) {
981981
### Examples
982982
983983
The various loader hooks can be used together to accomplish wide-ranging
984-
customizations of Node.js code loading and evaluation behaviors.
984+
customizations of the Node.js code loading and evaluation behaviors.
985985
986986
#### HTTPS loader
987987
@@ -1058,7 +1058,7 @@ prints the current version of CoffeeScript per the module at the URL in
10581058

10591059
#### Transpiler loader
10601060

1061-
Sources that are in formats Node.js doesnt understand can be converted into
1061+
Sources that are in formats Node.js doesn't understand can be converted into
10621062
JavaScript using the [`load` hook][load hook]. Before that hook gets called,
10631063
however, a [`resolve` hook][resolve hook] needs to tell Node.js not to
10641064
throw an error on unknown file types.

doc/api/events.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -811,7 +811,7 @@ stack trace for such warnings.
811811

812812
The emitted warning can be inspected with [`process.on('warning')`][] and will
813813
have the additional `emitter`, `type`, and `count` properties, referring to
814-
the event emitter instance, the events name and the number of attached
814+
the event emitter instance, the event's name and the number of attached
815815
listeners, respectively.
816816
Its `name` property is set to `'MaxListenersExceededWarning'`.
817817

@@ -1624,7 +1624,7 @@ added: v14.5.0
16241624
-->
16251625

16261626
* `event` {Event}
1627-
* Returns: {boolean} `true` if either events `cancelable` attribute value is
1627+
* Returns: {boolean} `true` if either event's `cancelable` attribute value is
16281628
false or its `preventDefault()` method was not invoked, otherwise `false`.
16291629

16301630
Dispatches the `event` to the list of handlers for `event.type`.

doc/api/fs.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2480,7 +2480,7 @@ The "not recommended" examples above check for existence and then use the
24802480
file; the "recommended" examples are better because they use the file directly
24812481
and handle the error, if any.
24822482
2483-
In general, check for the existence of a file only if the file wont be
2483+
In general, check for the existence of a file only if the file won't be
24842484
used directly, for example when its existence is a signal from another
24852485
process.
24862486
@@ -3810,7 +3810,7 @@ If the `target` does not exist, `'file'` will be used. Windows junction points
38103810
require the destination path to be absolute. When using `'junction'`, the
38113811
`target` argument will automatically be normalized to absolute path.
38123812

3813-
Relative targets are relative to the links parent directory.
3813+
Relative targets are relative to the link's parent directory.
38143814
38153815
```mjs
38163816
import { symlink } from 'node:fs';

doc/api/packages.md

+16-16
Original file line numberDiff line numberDiff line change
@@ -224,7 +224,7 @@ in your project's `package.json`.
224224

225225
## Package entry points
226226

227-
In a packages `package.json` file, two fields can define entry points for a
227+
In a package's `package.json` file, two fields can define entry points for a
228228
package: [`"main"`][] and [`"exports"`][]. The [`"main"`][] field is supported
229229
in all versions of Node.js, but its capabilities are limited: it only defines
230230
the main entry point of the package.
@@ -255,7 +255,7 @@ likely be a breaking change.**
255255

256256
To make the introduction of [`"exports"`][] non-breaking, ensure that every
257257
previously supported entry point is exported. It is best to explicitly specify
258-
entry points so that the packages public API is well-defined. For example,
258+
entry points so that the package's public API is well-defined. For example,
259259
a project that previous exported `main`, `lib`,
260260
`feature`, and the `package.json` could use the following `package.exports`:
261261

@@ -303,7 +303,7 @@ path `import feature from 'my-mod/feature/index.js`.
303303
### Main entry point export
304304

305305
To set the main entry point for a package, it is advisable to define both
306-
[`"exports"`][] and [`"main"`][] in the packages [`package.json`][] file:
306+
[`"exports"`][] and [`"main"`][] in the package's [`package.json`][] file:
307307

308308
```json
309309
{
@@ -745,8 +745,8 @@ changes:
745745
description: Unflag self-referencing a package using its name.
746746
-->
747747

748-
Within a package, the values defined in the packages
749-
`package.json` [`"exports"`][] field can be referenced via the packages name.
748+
Within a package, the values defined in the package's
749+
`package.json` [`"exports"`][] field can be referenced via the package's name.
750750
For example, assuming the `package.json` is:
751751

752752
```json
@@ -950,7 +950,7 @@ This approach is appropriate for any of the following use cases:
950950
install both this package and those other packages. For example a `utilities`
951951
package is used directly in an application, and a `utilities-plus` package
952952
adds a few more functions to `utilities`. Because the wrapper exports
953-
underlying CommonJS files, it doesnt matter if `utilities-plus` is written in
953+
underlying CommonJS files, it doesn't matter if `utilities-plus` is written in
954954
CommonJS or ES module syntax; it will work either way.
955955
* The package stores internal state, and the package author would prefer not to
956956
refactor the package to isolate its state management. See the next section.
@@ -960,7 +960,7 @@ be to add an export, e.g. `"./module"`, to point to an all-ES module-syntax
960960
version of the package. This could be used via `import 'pkg/module'` by users
961961
who are certain that the CommonJS version will not be loaded anywhere in the
962962
application, such as by dependencies; or if the CommonJS version can be loaded
963-
but doesnt affect the ES module version (for example, because the package is
963+
but doesn't affect the ES module version (for example, because the package is
964964
stateless):
965965

966966
```json
@@ -994,22 +994,22 @@ points directly:
994994

995995
This can be done if both the CommonJS and ES module versions of the package are
996996
equivalent, for example because one is the transpiled output of the other; and
997-
the packages management of state is carefully isolated (or the package is
997+
the package's management of state is carefully isolated (or the package is
998998
stateless).
999999

10001000
The reason that state is an issue is because both the CommonJS and ES module
10011001
versions of the package might get used within an application; for example, the
1002-
users application code could `import` the ES module version while a dependency
1002+
user's application code could `import` the ES module version while a dependency
10031003
`require`s the CommonJS version. If that were to occur, two copies of the
10041004
package would be loaded in memory and therefore two separate states would be
10051005
present. This would likely cause hard-to-troubleshoot bugs.
10061006

1007-
Aside from writing a stateless package (if JavaScripts `Math` were a package,
1007+
Aside from writing a stateless package (if JavaScript's `Math` were a package,
10081008
for example, it would be stateless as all of its methods are static), there are
1009-
some ways to isolate state so that its shared between the potentially loaded
1009+
some ways to isolate state so that it's shared between the potentially loaded
10101010
CommonJS and ES module instances of the package:
10111011

1012-
1. If possible, contain all state within an instantiated object. JavaScripts
1012+
1. If possible, contain all state within an instantiated object. JavaScript's
10131013
`Date`, for example, needs to be instantiated to contain state; if it were a
10141014
package, it would be used like this:
10151015

@@ -1019,7 +1019,7 @@ CommonJS and ES module instances of the package:
10191019
// someDate contains state; Date does not
10201020
```
10211021

1022-
The `new` keyword isnt required; a packages function can return a new
1022+
The `new` keyword isn't required; a package's function can return a new
10231023
object, or modify a passed-in object, to keep the state external to the
10241024
package.
10251025

@@ -1046,7 +1046,7 @@ CommonJS and ES module instances of the package:
10461046
each reference of `pkg` will contain the same state; and modifying that
10471047
state from either module system will apply to both.
10481048

1049-
Any plugins that attach to the packages singleton would need to separately
1049+
Any plugins that attach to the package's singleton would need to separately
10501050
attach to both the CommonJS and ES module singletons.
10511051

10521052
This approach is appropriate for any of the following use cases:
@@ -1121,7 +1121,7 @@ changes:
11211121
}
11221122
```
11231123

1124-
The `"name"` field defines your packages name. Publishing to the
1124+
The `"name"` field defines your package's name. Publishing to the
11251125
_npm_ registry requires a name that satisfies
11261126
[certain requirements](https://docs.npmjs.com/files/package.json#name).
11271127

@@ -1202,7 +1202,7 @@ Files ending with `.js` are loaded as ES modules when the nearest parent
12021202
`"module"`.
12031203

12041204
The nearest parent `package.json` is defined as the first `package.json` found
1205-
when searching in the current folder, that folders parent, and so on up
1205+
when searching in the current folder, that folder's parent, and so on up
12061206
until a node\_modules folder or the volume root is reached.
12071207

12081208
```json

doc/api/process.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1523,7 +1523,7 @@ added: v0.1.27
15231523
changes:
15241524
- version: v11.14.0
15251525
pr-url: https://github.com/nodejs/node/pull/26544
1526-
description: Worker threads will now use a copy of the parent threads
1526+
description: Worker threads will now use a copy of the parent thread's
15271527
`process.env` by default, configurable through the `env`
15281528
option of the `Worker` constructor.
15291529
- version: v10.0.0
@@ -1646,7 +1646,7 @@ console.log(env.test);
16461646
16471647
Unless explicitly specified when creating a [`Worker`][] instance,
16481648
each [`Worker`][] thread has its own copy of `process.env`, based on its
1649-
parent threads `process.env`, or whatever was specified as the `env` option
1649+
parent thread's `process.env`, or whatever was specified as the `env` option
16501650
to the [`Worker`][] constructor. Changes to `process.env` will not be visible
16511651
across [`Worker`][] threads, and only the main thread can make changes that
16521652
are visible to the operating system or to native add-ons.

doc/api/synopsis.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Commands in this document start with `$` or `>` to replicate how they would
1919
appear in a user's terminal. Do not include the `$` and `>` characters. They are
2020
there to show the start of each command.
2121

22-
Lines that dont start with `$` or `>` character show the output of the previous
22+
Lines that don't start with `$` or `>` character show the output of the previous
2323
command.
2424

2525
First, make sure to have downloaded and installed Node.js. See

doc/api/url.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -660,7 +660,7 @@ added: v16.7.0
660660
`URL.createObjectURL()`.
661661

662662
Removes the stored {Blob} identified by the given ID. Attempting to revoke a
663-
ID that isnt registered will silently fail.
663+
ID that isn't registered will silently fail.
664664

665665
### Class: `URLSearchParams`
666666

doc/api/v8.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -443,7 +443,7 @@ For use inside of a custom [`serializer._writeHostObject()`][].
443443

444444
* `buffer` {Buffer|TypedArray|DataView}
445445

446-
Write raw bytes into the serializers internal buffer. The deserializer
446+
Write raw bytes into the serializer's internal buffer. The deserializer
447447
will require a way to compute the length of the buffer.
448448
For use inside of a custom [`serializer._writeHostObject()`][].
449449

@@ -558,7 +558,7 @@ For use inside of a custom [`deserializer._readHostObject()`][].
558558
* `length` {integer}
559559
* Returns: {Buffer}
560560

561-
Read raw bytes from the deserializers internal buffer. The `length` parameter
561+
Read raw bytes from the deserializer's internal buffer. The `length` parameter
562562
must correspond to the length of the buffer that was passed to
563563
[`serializer.writeRawBytes()`][].
564564
For use inside of a custom [`deserializer._readHostObject()`][].

doc/api/worker_threads.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -235,7 +235,7 @@ changes:
235235
Receive a single message from a given `MessagePort`. If no message is available,
236236
`undefined` is returned, otherwise an object with a single `message` property
237237
that contains the message payload, corresponding to the oldest message in the
238-
`MessagePort`s queue.
238+
`MessagePort`'s queue.
239239

240240
```js
241241
const { MessageChannel, receiveMessageOnPort } = require('node:worker_threads');
@@ -332,7 +332,7 @@ added: v10.5.0
332332
-->
333333

334334
An arbitrary JavaScript value that contains a clone of the data passed
335-
to this threads `Worker` constructor.
335+
to this thread's `Worker` constructor.
336336

337337
The data is cloned as if using [`postMessage()`][`port.postMessage()`],
338338
according to the [HTML structured clone algorithm][].
@@ -929,7 +929,7 @@ changes:
929929
description: The `resourceLimits` option was introduced.
930930
-->
931931

932-
* `filename` {string|URL} The path to the Workers main script or module. Must
932+
* `filename` {string|URL} The path to the Worker's main script or module. Must
933933
be either an absolute path or a relative path (i.e. relative to the
934934
current working directory) starting with `./` or `../`, or a WHATWG `URL`
935935
object using `file:` or `data:` protocol.
@@ -945,7 +945,7 @@ changes:
945945
* `env` {Object} If set, specifies the initial value of `process.env` inside
946946
the Worker thread. As a special value, [`worker.SHARE_ENV`][] may be used
947947
to specify that the parent thread and the child thread should share their
948-
environment variables; in that case, changes to one threads `process.env`
948+
environment variables; in that case, changes to one thread's `process.env`
949949
object affect the other thread as well. **Default:** `process.env`.
950950
* `eval` {boolean} If `true` and the first argument is a `string`, interpret
951951
the first argument to the constructor as a script that is executed once the

doc/api/zlib.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -304,8 +304,8 @@ speed, at the cost of memory usage.
304304
There are equivalents to the zlib options for Brotli-based streams, although
305305
these options have different ranges than the zlib ones:
306306

307-
* zlibs `level` option matches Brotlis `BROTLI_PARAM_QUALITY` option.
308-
* zlibs `windowBits` option matches Brotlis `BROTLI_PARAM_LGWIN` option.
307+
* zlib's `level` option matches Brotli's `BROTLI_PARAM_QUALITY` option.
308+
* zlib's `windowBits` option matches Brotli's `BROTLI_PARAM_LGWIN` option.
309309

310310
See [below][Brotli parameters] for more details on Brotli-specific options.
311311

doc/contributing/cpp-style-guide.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ tools.
5151

5252
## Formatting
5353

54-
Unfortunately, the C++ linter (based on [Googles `cpplint`][]), which can be
54+
Unfortunately, the C++ linter (based on [Google's `cpplint`][]), which can be
5555
run explicitly via `make lint-cpp`, does not currently catch a lot of rules that
5656
are specific to the Node.js C++ code base. This document explains the most
5757
common of these rules:
@@ -117,7 +117,7 @@ void FunctionWithAVeryLongName(int parameter_with_a_very_long_name,
117117
...);
118118
```
119119
120-
If that doesnt work, break after the `(` and use 4 spaces of indentation:
120+
If that doesn't work, break after the `(` and use 4 spaces of indentation:
121121
122122
```cpp
123123
void FunctionWithAReallyReallyReallyLongNameSeriouslyStopIt(
@@ -397,7 +397,7 @@ even `try` and `catch` **will** break.
397397
[ES.48]: https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines#Res-casts
398398
[ES.49]: https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines#Res-casts-named
399399
[Google C++ Style Guide]: https://google.github.io/styleguide/cppguide.html
400-
[Googles `cpplint`]: https://github.com/google/styleguide
400+
[Google's `cpplint`]: https://github.com/google/styleguide
401401
[R.20]: https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines#Rr-owner
402402
[R.21]: https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines#Rr-unique
403403
[Run Time Type Information]: https://en.wikipedia.org/wiki/Run-time_type_information

doc/contributing/maintaining-icu.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -193,9 +193,9 @@ Floating patches are applied at `configure` time. The "patch" files
193193
are used instead of the original source files. The patch files are
194194
complete `.cpp` files replacing the original contents.
195195

196-
Patches are tied to a specific ICU version. They wont apply to a
196+
Patches are tied to a specific ICU version. They won't apply to a
197197
future ICU version. We assume that you filed a bug against [ICU][] and
198-
upstreamed the fix, so the patch wont be needed in a later ICU
198+
upstreamed the fix, so the patch won't be needed in a later ICU
199199
version.
200200

201201
### Example

0 commit comments

Comments
 (0)