Skip to content

Commit 498dfba

Browse files
Trottcodebytere
authored andcommitted
doc: use a single space between sentences
We mostly have a single space between the punctuation that ends a sentence and the start of the next sentence. Change instances with two spaces to one. PR-URL: #33995 Reviewed-By: Matheus Marchini <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]>
1 parent 9b8695f commit 498dfba

12 files changed

+33
-33
lines changed

doc/api/buffer.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2700,7 +2700,7 @@ it allows injection of numbers where a naively written application that does not
27002700
validate its input sufficiently might expect to always receive a string.
27012701
Before Node.js 8.0.0, the 100 byte buffer might contain
27022702
arbitrary pre-existing in-memory data, so may be used to expose in-memory
2703-
secrets to a remote attacker. Since Node.js 8.0.0, exposure of memory cannot
2703+
secrets to a remote attacker. Since Node.js 8.0.0, exposure of memory cannot
27042704
occur because the data is zero-filled. However, other attacks are still
27052705
possible, such as causing very large buffers to be allocated by the server,
27062706
leading to performance degradation or crashing on memory exhaustion.

doc/api/child_process.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -347,7 +347,7 @@ changes:
347347
* `detached` {boolean} Prepare child to run independently of its parent
348348
process. Specific behavior depends on the platform, see
349349
[`options.detached`][]).
350-
* `env` {Object} Environment key-value pairs. **Default:** `process.env`.
350+
* `env` {Object} Environment key-value pairs. **Default:** `process.env`.
351351
* `execPath` {string} Executable used to create the child process.
352352
* `execArgv` {string[]} List of string arguments passed to the executable.
353353
**Default:** `process.execArgv`.
@@ -735,7 +735,7 @@ changes:
735735
* `stdio` {string|Array} Child's stdio configuration. `stderr` by default will
736736
be output to the parent process' stderr unless `stdio` is specified.
737737
**Default:** `'pipe'`.
738-
* `env` {Object} Environment key-value pairs. **Default:** `process.env`.
738+
* `env` {Object} Environment key-value pairs. **Default:** `process.env`.
739739
* `uid` {number} Sets the user identity of the process (see setuid(2)).
740740
* `gid` {number} Sets the group identity of the process (see setgid(2)).
741741
* `timeout` {number} In milliseconds the maximum amount of time the process
@@ -865,7 +865,7 @@ changes:
865865
* `argv0` {string} Explicitly set the value of `argv[0]` sent to the child
866866
process. This will be set to `command` if not specified.
867867
* `stdio` {string|Array} Child's stdio configuration.
868-
* `env` {Object} Environment key-value pairs. **Default:** `process.env`.
868+
* `env` {Object} Environment key-value pairs. **Default:** `process.env`.
869869
* `uid` {number} Sets the user identity of the process (see setuid(2)).
870870
* `gid` {number} Sets the group identity of the process (see setgid(2)).
871871
* `timeout` {number} In milliseconds the maximum amount of time the process

doc/api/crypto.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2060,7 +2060,7 @@ added: v0.1.92
20602060
* `options` {Object} [`stream.Writable` options][]
20612061
* Returns: {Sign}
20622062

2063-
Creates and returns a `Sign` object that uses the given `algorithm`. Use
2063+
Creates and returns a `Sign` object that uses the given `algorithm`. Use
20642064
[`crypto.getHashes()`][] to obtain the names of the available digest algorithms.
20652065
Optional `options` argument controls the `stream.Writable` behavior.
20662066

doc/api/fs.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -3594,14 +3594,14 @@ changes:
35943594
* `err` {Error}
35953595

35963596
Asynchronous symlink(2) which creates the link called `path` pointing to
3597-
`target`. No arguments other than a possible exception are given to the
3597+
`target`. No arguments other than a possible exception are given to the
35983598
completion callback.
35993599

36003600
The `type` argument is only available on Windows and ignored on other platforms.
36013601
It can be set to `'dir'`, `'file'`, or `'junction'`. If the `type` argument is
36023602
not set, Node.js will autodetect `target` type and use `'file'` or `'dir'`. If
36033603
the `target` does not exist, `'file'` will be used. Windows junction points
3604-
require the destination path to be absolute. When using `'junction'`, the
3604+
require the destination path to be absolute. When using `'junction'`, the
36053605
`target` argument will automatically be normalized to absolute path.
36063606

36073607
Relative targets are relative to the link’s parent directory.
@@ -4200,7 +4200,7 @@ before and/or after the newly written data.
42004200
For example, if `fs.writeFile()` is called twice in a row, first to write the
42014201
string `'Hello'`, then to write the string `', World'`, the file would contain
42024202
`'Hello, World'`, and might contain some of the file's original data (depending
4203-
on the size of the original file, and the position of the file descriptor). If
4203+
on the size of the original file, and the position of the file descriptor). If
42044204
a file name had been used instead of a descriptor, the file would be guaranteed
42054205
to contain only `', World'`.
42064206

doc/api/modules.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -165,15 +165,15 @@ require(X) from module at path Y
165165
6. THROW "not found"
166166
167167
LOAD_AS_FILE(X)
168-
1. If X is a file, load X as its file extension format. STOP
169-
2. If X.js is a file, load X.js as JavaScript text. STOP
170-
3. If X.json is a file, parse X.json to a JavaScript Object. STOP
171-
4. If X.node is a file, load X.node as binary addon. STOP
168+
1. If X is a file, load X as its file extension format. STOP
169+
2. If X.js is a file, load X.js as JavaScript text. STOP
170+
3. If X.json is a file, parse X.json to a JavaScript Object. STOP
171+
4. If X.node is a file, load X.node as binary addon. STOP
172172
173173
LOAD_INDEX(X)
174-
1. If X/index.js is a file, load X/index.js as JavaScript text. STOP
174+
1. If X/index.js is a file, load X/index.js as JavaScript text. STOP
175175
2. If X/index.json is a file, parse X/index.json to a JavaScript object. STOP
176-
3. If X/index.node is a file, load X/index.node as binary addon. STOP
176+
3. If X/index.node is a file, load X/index.node as binary addon. STOP
177177
178178
LOAD_AS_DIRECTORY(X)
179179
1. If X/package.json is a file,
@@ -234,7 +234,7 @@ LOAD_PACKAGE_EXPORTS(DIR, X)
234234
a. LOAD_AS_FILE(RESOLVED)
235235
b. LOAD_AS_DIRECTORY(RESOLVED)
236236
12. Otherwise
237-
a. If RESOLVED is a file, load it as its file extension format. STOP
237+
a. If RESOLVED is a file, load it as its file extension format. STOP
238238
13. Throw "not found"
239239
```
240240

doc/api/n-api.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -646,7 +646,7 @@ typedef void (*napi_async_execute_callback)(napi_env env, void* data);
646646

647647
Implementations of this function must avoid making N-API calls
648648
that execute JavaScript or interact with
649-
JavaScript objects. N-API
649+
JavaScript objects. N-API
650650
calls should be in the `napi_async_complete_callback` instead.
651651
Do not use the `napi_env` parameter as it will likely
652652
result in execution of JavaScript.

doc/api/net.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -721,7 +721,7 @@ added: v6.1.0
721721
If `true`,
722722
[`socket.connect(options[, connectListener])`][`socket.connect(options)`] was
723723
called and has not yet finished. It will stay `true` until the socket becomes
724-
connected, then it is set to `false` and the `'connect'` event is emitted. Note
724+
connected, then it is set to `false` and the `'connect'` event is emitted. Note
725725
that the
726726
[`socket.connect(options[, connectListener])`][`socket.connect(options)`]
727727
callback is a listener for the `'connect'` event.

doc/api/process.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -554,7 +554,7 @@ environment variable.
554554

555555
`process.allowedNodeEnvironmentFlags` extends `Set`, but overrides
556556
`Set.prototype.has` to recognize several different possible flag
557-
representations. `process.allowedNodeEnvironmentFlags.has()` will
557+
representations. `process.allowedNodeEnvironmentFlags.has()` will
558558
return `true` in the following cases:
559559

560560
* Flags may omit leading single (`-`) or double (`--`) dashes; e.g.,

doc/api/readline.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -361,7 +361,7 @@ The current input data being processed by node.
361361

362362
This can be used when collecting input from a TTY stream to retrieve the
363363
current value that has been processed thus far, prior to the `line` event
364-
being emitted. Once the `line` event has been emitted, this property will
364+
being emitted. Once the `line` event has been emitted, this property will
365365
be an empty string.
366366

367367
Be aware that modifying the value during the instance runtime may have
@@ -395,7 +395,7 @@ added: v0.1.98
395395
The cursor position relative to `rl.line`.
396396

397397
This will track where the current cursor lands in the input string, when
398-
reading input from a TTY stream. The position of cursor determines the
398+
reading input from a TTY stream. The position of cursor determines the
399399
portion of the input string that will be modified as input is processed,
400400
as well as the column where the terminal caret will be rendered.
401401

@@ -409,7 +409,7 @@ added: v12.16.0
409409
* `cols` {number} the screen column the cursor currently lands on
410410

411411
Returns the real position of the cursor in relation to the input
412-
prompt + string. Long input (wrapping) strings, as well as multiple
412+
prompt + string. Long input (wrapping) strings, as well as multiple
413413
line prompts are included in the calculations.
414414

415415
## `readline.clearLine(stream, dir[, callback])`

doc/api/stream.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1761,7 +1761,7 @@ changes:
17611761
specified in the [`stream.write()`][stream-write] call) before passing
17621762
them to [`stream._write()`][stream-_write]. Other types of data are not
17631763
converted (i.e. `Buffer`s are not decoded into `string`s). Setting to
1764-
false will prevent `string`s from being converted. **Default:** `true`.
1764+
false will prevent `string`s from being converted. **Default:** `true`.
17651765
* `defaultEncoding` {string} The default encoding that is used when no
17661766
encoding is specified as an argument to [`stream.write()`][stream-write].
17671767
**Default:** `'utf8'`.

doc/api/tls.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -325,9 +325,9 @@ in [`tls.createServer()`][], [`tls.connect()`][], and when creating new
325325

326326
The ciphers list can contain a mixture of TLSv1.3 cipher suite names, the ones
327327
that start with `'TLS_'`, and specifications for TLSv1.2 and below cipher
328-
suites. The TLSv1.2 ciphers support a legacy specification format, consult
328+
suites. The TLSv1.2 ciphers support a legacy specification format, consult
329329
the OpenSSL [cipher list format][] documentation for details, but those
330-
specifications do *not* apply to TLSv1.3 ciphers. The TLSv1.3 suites can only
330+
specifications do *not* apply to TLSv1.3 ciphers. The TLSv1.3 suites can only
331331
be enabled by including their full name in the cipher list. They cannot, for
332332
example, be enabled or disabled by using the legacy TLSv1.2 `'EECDH'` or
333333
`'!EECDH'` specification.
@@ -768,12 +768,12 @@ On the client, the `session` can be provided to the `session` option of
768768
See [Session Resumption][] for more information.
769769

770770
For TLSv1.2 and below, [`tls.TLSSocket.getSession()`][] can be called once
771-
the handshake is complete. For TLSv1.3, only ticket-based resumption is allowed
771+
the handshake is complete. For TLSv1.3, only ticket-based resumption is allowed
772772
by the protocol, multiple tickets are sent, and the tickets aren't sent until
773773
after the handshake completes. So it is necessary to wait for the
774-
`'session'` event to get a resumable session. Applications
774+
`'session'` event to get a resumable session. Applications
775775
should use the `'session'` event instead of `getSession()` to ensure
776-
they will work for all TLS versions. Applications that only expect to
776+
they will work for all TLS versions. Applications that only expect to
777777
get or use one session should listen for this event only once:
778778

779779
```js
@@ -1610,11 +1610,11 @@ changes:
16101610
[OpenSSL Options][].
16111611
* `secureProtocol` {string} Legacy mechanism to select the TLS protocol
16121612
version to use, it does not support independent control of the minimum and
1613-
maximum version, and does not support limiting the protocol to TLSv1.3. Use
1614-
`minVersion` and `maxVersion` instead. The possible values are listed as
1615-
[SSL_METHODS][], use the function names as strings. For example, use
1613+
maximum version, and does not support limiting the protocol to TLSv1.3. Use
1614+
`minVersion` and `maxVersion` instead. The possible values are listed as
1615+
[SSL_METHODS][], use the function names as strings. For example, use
16161616
`'TLSv1_1_method'` to force TLS version 1.1, or `'TLS_method'` to allow any
1617-
TLS protocol version up to TLSv1.3. It is not recommended to use TLS
1617+
TLS protocol version up to TLSv1.3. It is not recommended to use TLS
16181618
versions less than 1.2, but it may be required for interoperability.
16191619
**Default:** none, see `minVersion`.
16201620
* `sessionIdContext` {string} Opaque identifier used by servers to ensure
@@ -1812,7 +1812,7 @@ added: v11.4.0
18121812
[`tls.createSecureContext()`][]. It can be assigned any of the supported TLS
18131813
protocol versions, `'TLSv1.3'`, `'TLSv1.2'`, `'TLSv1.1'`, or `'TLSv1'`.
18141814
**Default:** `'TLSv1.3'`, unless changed using CLI options. Using
1815-
`--tls-max-v1.2` sets the default to `'TLSv1.2'`. Using `--tls-max-v1.3` sets
1815+
`--tls-max-v1.2` sets the default to `'TLSv1.2'`. Using `--tls-max-v1.3` sets
18161816
the default to `'TLSv1.3'`. If multiple of the options are provided, the
18171817
highest maximum is used.
18181818

doc/api/util.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1262,7 +1262,7 @@ added: v10.0.0
12621262
* Returns: {boolean}
12631263

12641264
Returns `true` if the value is an instance of one of the [`ArrayBuffer`][]
1265-
views, such as typed array objects or [`DataView`][]. Equivalent to
1265+
views, such as typed array objects or [`DataView`][]. Equivalent to
12661266
[`ArrayBuffer.isView()`][].
12671267

12681268
```js

0 commit comments

Comments
 (0)