Skip to content

Commit 895cc57

Browse files
authored
doc: use ASCII apostrophes consistently
PR-URL: nodejs#43114 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Darshan Sen <raisinten@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
1 parent 70069b2 commit 895cc57

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
@@ -318,7 +318,7 @@ console.log(uint16array);
318318
```
319319

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

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
@@ -2569,7 +2569,7 @@ changes:
25692569
Type: Runtime
25702570

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

25742574
### DEP0133: `http` `connection`
25752575

doc/api/esm.md

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

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

@@ -719,7 +719,7 @@ Hooks are part of a chain, even if that chain consists of only one custom
719719
(user-provided) hook and the default hook, which is always present. Hook
720720
functions nest: each one must always return a plain object, and chaining happens
721721
as a result of each function calling `next<hookName>()`, which is a reference
722-
to the subsequent loaders hook.
722+
to the subsequent loader's hook.
723723
724724
A hook that returns a value lacking a required property triggers an exception.
725725
A hook that returns without calling `next<hookName>()` _and_ without returning
@@ -989,7 +989,7 @@ export function globalPreload({ port }) {
989989
### Examples
990990
991991
The various loader hooks can be used together to accomplish wide-ranging
992-
customizations of Node.js code loading and evaluation behaviors.
992+
customizations of the Node.js code loading and evaluation behaviors.
993993
994994
#### HTTPS loader
995995
@@ -1066,7 +1066,7 @@ prints the current version of CoffeeScript per the module at the URL in
10661066

10671067
#### Transpiler loader
10681068

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

doc/api/events.md

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

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

@@ -1633,7 +1633,7 @@ added: v14.5.0
16331633
-->
16341634

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

16391639
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
@@ -2534,7 +2534,7 @@ The "not recommended" examples above check for existence and then use the
25342534
file; the "recommended" examples are better because they use the file directly
25352535
and handle the error, if any.
25362536
2537-
In general, check for the existence of a file only if the file wont be
2537+
In general, check for the existence of a file only if the file won't be
25382538
used directly, for example when its existence is a signal from another
25392539
process.
25402540
@@ -4008,7 +4008,7 @@ If the `target` does not exist, `'file'` will be used. Windows junction points
40084008
require the destination path to be absolute. When using `'junction'`, the
40094009
`target` argument will automatically be normalized to absolute path.
40104010

4011-
Relative targets are relative to the links parent directory.
4011+
Relative targets are relative to the link's parent directory.
40124012
40134013
```mjs
40144014
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
{
@@ -700,8 +700,8 @@ changes:
700700
description: Unflag self-referencing a package using its name.
701701
-->
702702

703-
Within a package, the values defined in the packages
704-
`package.json` [`"exports"`][] field can be referenced via the packages name.
703+
Within a package, the values defined in the package's
704+
`package.json` [`"exports"`][] field can be referenced via the package's name.
705705
For example, assuming the `package.json` is:
706706

707707
```json
@@ -905,7 +905,7 @@ This approach is appropriate for any of the following use cases:
905905
install both this package and those other packages. For example a `utilities`
906906
package is used directly in an application, and a `utilities-plus` package
907907
adds a few more functions to `utilities`. Because the wrapper exports
908-
underlying CommonJS files, it doesnt matter if `utilities-plus` is written in
908+
underlying CommonJS files, it doesn't matter if `utilities-plus` is written in
909909
CommonJS or ES module syntax; it will work either way.
910910
* The package stores internal state, and the package author would prefer not to
911911
refactor the package to isolate its state management. See the next section.
@@ -915,7 +915,7 @@ be to add an export, e.g. `"./module"`, to point to an all-ES module-syntax
915915
version of the package. This could be used via `import 'pkg/module'` by users
916916
who are certain that the CommonJS version will not be loaded anywhere in the
917917
application, such as by dependencies; or if the CommonJS version can be loaded
918-
but doesnt affect the ES module version (for example, because the package is
918+
but doesn't affect the ES module version (for example, because the package is
919919
stateless):
920920

921921
```json
@@ -949,22 +949,22 @@ points directly:
949949

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

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

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

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

@@ -974,7 +974,7 @@ CommonJS and ES module instances of the package:
974974
// someDate contains state; Date does not
975975
```
976976

977-
The `new` keyword isnt required; a packages function can return a new
977+
The `new` keyword isn't required; a package's function can return a new
978978
object, or modify a passed-in object, to keep the state external to the
979979
package.
980980

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

1004-
Any plugins that attach to the packages singleton would need to separately
1004+
Any plugins that attach to the package's singleton would need to separately
10051005
attach to both the CommonJS and ES module singletons.
10061006

10071007
This approach is appropriate for any of the following use cases:
@@ -1076,7 +1076,7 @@ changes:
10761076
}
10771077
```
10781078

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

@@ -1159,7 +1159,7 @@ Files ending with `.js` are loaded as ES modules when the nearest parent
11591159
`"module"`.
11601160

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

11651165
```json

doc/api/process.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1527,7 +1527,7 @@ added: v0.1.27
15271527
changes:
15281528
- version: v11.14.0
15291529
pr-url: https://github.com/nodejs/node/pull/26544
1530-
description: Worker threads will now use a copy of the parent threads
1530+
description: Worker threads will now use a copy of the parent thread's
15311531
`process.env` by default, configurable through the `env`
15321532
option of the `Worker` constructor.
15331533
- version: v10.0.0
@@ -1650,7 +1650,7 @@ console.log(env.test);
16501650
16511651
Unless explicitly specified when creating a [`Worker`][] instance,
16521652
each [`Worker`][] thread has its own copy of `process.env`, based on its
1653-
parent threads `process.env`, or whatever was specified as the `env` option
1653+
parent thread's `process.env`, or whatever was specified as the `env` option
16541654
to the [`Worker`][] constructor. Changes to `process.env` will not be visible
16551655
across [`Worker`][] threads, and only the main thread can make changes that
16561656
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
@@ -456,7 +456,7 @@ For use inside of a custom [`serializer._writeHostObject()`][].
456456

457457
* `buffer` {Buffer|TypedArray|DataView}
458458

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

@@ -571,7 +571,7 @@ For use inside of a custom [`deserializer._readHostObject()`][].
571571
* `length` {integer}
572572
* Returns: {Buffer}
573573

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

doc/api/worker_threads.md

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

242242
```js
243243
const { MessageChannel, receiveMessageOnPort } = require('node:worker_threads');
@@ -336,7 +336,7 @@ added: v10.5.0
336336
-->
337337

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

341341
The data is cloned as if using [`postMessage()`][`port.postMessage()`],
342342
according to the [HTML structured clone algorithm][].
@@ -939,7 +939,7 @@ changes:
939939
description: The `resourceLimits` option was introduced.
940940
-->
941941

942-
* `filename` {string|URL} The path to the Workers main script or module. Must
942+
* `filename` {string|URL} The path to the Worker's main script or module. Must
943943
be either an absolute path or a relative path (i.e. relative to the
944944
current working directory) starting with `./` or `../`, or a WHATWG `URL`
945945
object using `file:` or `data:` protocol.
@@ -955,7 +955,7 @@ changes:
955955
* `env` {Object} If set, specifies the initial value of `process.env` inside
956956
the Worker thread. As a special value, [`worker.SHARE_ENV`][] may be used
957957
to specify that the parent thread and the child thread should share their
958-
environment variables; in that case, changes to one threads `process.env`
958+
environment variables; in that case, changes to one thread's `process.env`
959959
object affect the other thread as well. **Default:** `process.env`.
960960
* `eval` {boolean} If `true` and the first argument is a `string`, interpret
961961
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)