Skip to content

Commit e00923b

Browse files
TrottMylesBorins
authored andcommitted
doc: add missing serial commas
PR-URL: #17384 Reviewed-By: Timothy Gu <[email protected]> Reviewed-By: Alexey Orlenko <[email protected]> Reviewed-By: Refael Ackermann <[email protected]> Reviewed-By: Myles Borins <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Daniel Bevenius <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Jon Moss <[email protected]> Reviewed-By: Michael Dawson <[email protected]> Reviewed-By: Richard Lau <[email protected]> Reviewed-By: Tobias Nießen <[email protected]>
1 parent 9df52dd commit e00923b

15 files changed

+29
-29
lines changed

COLLABORATOR_GUIDE.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
- [How is an LTS release cut?](#how-is-an-lts-release-cut)
3434

3535
This document contains information for Collaborators of the Node.js
36-
project regarding maintaining the code, documentation and issues.
36+
project regarding maintaining the code, documentation, and issues.
3737

3838
Collaborators should be familiar with the guidelines for new
3939
contributors in [CONTRIBUTING.md](./CONTRIBUTING.md) and also

CONTRIBUTING.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ for any individual to *act* in such a manner that is not in violation of the
7474
strict letter of the Code of Conduct guidelines while still going completely
7575
against the spirit of what that Code is intended to accomplish.
7676

77-
Open, diverse and inclusive communities live and die on the basis of trust.
77+
Open, diverse, and inclusive communities live and die on the basis of trust.
7878
Contributors can disagree with one another so long as they trust that those
7979
disagreements are in good faith and everyone is working towards a common goal.
8080

@@ -177,7 +177,7 @@ Node.js changed that broke the module.
177177
Once an issue has been opened, it is not uncommon for there to be discussion
178178
around it. Some contributors may have differing opinions about the issue,
179179
including whether the behavior being seen is a bug or a feature. This discussion
180-
is part of the process and should be kept focused, helpful and professional.
180+
is part of the process and should be kept focused, helpful, and professional.
181181

182182
Short, clipped responses—that provide neither additional context nor supporting
183183
detail—are not helpful or professional. To many, such responses are simply

CPP_STYLE_GUIDE.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
* [4 spaces of indentation for statement continuations](#4-spaces-of-indentation-for-statement-continuations)
88
* [Align function arguments vertically](#align-function-arguments-vertically)
99
* [Initialization lists](#initialization-lists)
10-
* [CamelCase for methods, functions and classes](#camelcase-for-methods-functions-and-classes)
10+
* [CamelCase for methods, functions, and classes](#camelcase-for-methods-functions-and-classes)
1111
* [snake\_case for local variables and parameters](#snake_case-for-local-variables-and-parameters)
1212
* [snake\_case\_ for private class fields](#snake_case_-for-private-class-fields)
1313
* [Space after `template`](#space-after-template)
@@ -87,7 +87,7 @@ HandleWrap::HandleWrap(Environment* env,
8787
handle_(handle) {
8888
```
8989
90-
## CamelCase for methods, functions and classes
90+
## CamelCase for methods, functions, and classes
9191
9292
Exceptions are simple getters/setters, which are named `property_name()` and
9393
`set_property_name()`, respectively.

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ documentation of the latest stable version.
116116

117117
### Verifying Binaries
118118

119-
Current, LTS and Nightly download directories all contain a _SHASUMS256.txt_
119+
Current, LTS, and Nightly download directories all contain a _SHASUMS256.txt_
120120
file that lists the SHA checksums for each file available for
121121
download.
122122

doc/api/addons.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ involving knowledge of several components and APIs :
2020
threads and all of the asynchronous behaviors of the platform. It also
2121
serves as a cross-platform abstraction library, giving easy, POSIX-like
2222
access across all major operating systems to many common system tasks, such
23-
as interacting with the filesystem, sockets, timers and system events. libuv
23+
as interacting with the filesystem, sockets, timers, and system events. libuv
2424
also provides a pthreads-like threading abstraction that may be used to
2525
power more sophisticated asynchronous Addons that need to move beyond the
2626
standard event loop. Addon authors are encouraged to think about how to

doc/api/buffer.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ changes:
154154
-->
155155

156156
`Buffer` instances are commonly used to represent sequences of encoded characters
157-
such as UTF-8, UCS2, Base64 or even Hex-encoded data. It is possible to
157+
such as UTF-8, UCS2, Base64, or even Hex-encoded data. It is possible to
158158
convert back and forth between `Buffer` instances and ordinary JavaScript strings
159159
by using an explicit character encoding.
160160

doc/api/child_process.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -628,7 +628,7 @@ pipes between the parent and child. The value is one of the following:
628628
5. Positive integer - The integer value is interpreted as a file descriptor
629629
that is is currently open in the parent process. It is shared with the child
630630
process, similar to how {Stream} objects can be shared.
631-
6. `null`, `undefined` - Use default value. For stdio fds 0, 1 and 2 (in other
631+
6. `null`, `undefined` - Use default value. For stdio fds 0, 1, and 2 (in other
632632
words, stdin, stdout, and stderr) a pipe is created. For fd 3 and up, the
633633
default is `'ignore'`.
634634

doc/api/crypto.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
> Stability: 2 - Stable
66
77
The `crypto` module provides cryptographic functionality that includes a set of
8-
wrappers for OpenSSL's hash, HMAC, cipher, decipher, sign and verify functions.
8+
wrappers for OpenSSL's hash, HMAC, cipher, decipher, sign, and verify functions.
99

1010
Use `require('crypto')` to access this module.
1111

@@ -1254,7 +1254,7 @@ In line with OpenSSL's recommendation to use pbkdf2 instead of
12541254
[`EVP_BytesToKey`][] it is recommended that developers derive a key and IV on
12551255
their own using [`crypto.pbkdf2()`][] and to use [`crypto.createCipheriv()`][]
12561256
to create the `Cipher` object. Users should not use ciphers with counter mode
1257-
(e.g. CTR, GCM or CCM) in `crypto.createCipher()`. A warning is emitted when
1257+
(e.g. CTR, GCM, or CCM) in `crypto.createCipher()`. A warning is emitted when
12581258
they are used in order to avoid the risk of IV reuse that causes
12591259
vulnerabilities. For the case when IV is reused in GCM, see [Nonce-Disrespecting
12601260
Adversaries][] for details.
@@ -2034,7 +2034,7 @@ Based on the recommendations of [NIST SP 800-131A][]:
20342034

20352035
- MD5 and SHA-1 are no longer acceptable where collision resistance is
20362036
required such as digital signatures.
2037-
- The key used with RSA, DSA and DH algorithms is recommended to have
2037+
- The key used with RSA, DSA, and DH algorithms is recommended to have
20382038
at least 2048 bits and that of the curve of ECDSA and ECDH at least
20392039
224 bits, to be safe to use for several years.
20402040
- The DH groups of `modp1`, `modp2` and `modp5` have a key size

doc/api/fs.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1881,7 +1881,7 @@ Linux, and Windows, an error will be returned. On FreeBSD, a representation
18811881
of the directory's contents will be returned.
18821882

18831883
```js
1884-
// macOS, Linux and Windows
1884+
// macOS, Linux, and Windows
18851885
fs.readFile('<directory>', (err, data) => {
18861886
// => [Error: EISDIR: illegal operation on a directory, read <directory>]
18871887
});
@@ -1929,7 +1929,7 @@ string. Otherwise it returns a buffer.
19291929
behavior of `fs.readFileSync()` is platform-specific.
19301930

19311931
```js
1932-
// macOS, Linux and Windows
1932+
// macOS, Linux, and Windows
19331933
fs.readFileSync('<directory>');
19341934
// => [Error: EISDIR: illegal operation on a directory, read <directory>]
19351935

@@ -3043,7 +3043,7 @@ The following constants are meant for use with the [`fs.Stats`][] object's
30433043
</tr>
30443044
<tr>
30453045
<td><code>S_IRWXU</code></td>
3046-
<td>File mode indicating readable, writable and executable by owner.</td>
3046+
<td>File mode indicating readable, writable, and executable by owner.</td>
30473047
</tr>
30483048
<tr>
30493049
<td><code>S_IRUSR</code></td>
@@ -3059,7 +3059,7 @@ The following constants are meant for use with the [`fs.Stats`][] object's
30593059
</tr>
30603060
<tr>
30613061
<td><code>S_IRWXG</code></td>
3062-
<td>File mode indicating readable, writable and executable by group.</td>
3062+
<td>File mode indicating readable, writable, and executable by group.</td>
30633063
</tr>
30643064
<tr>
30653065
<td><code>S_IRGRP</code></td>
@@ -3075,7 +3075,7 @@ The following constants are meant for use with the [`fs.Stats`][] object's
30753075
</tr>
30763076
<tr>
30773077
<td><code>S_IRWXO</code></td>
3078-
<td>File mode indicating readable, writable and executable by others.</td>
3078+
<td>File mode indicating readable, writable, and executable by others.</td>
30793079
</tr>
30803080
<tr>
30813081
<td><code>S_IROTH</code></td>

doc/api/http2.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1264,7 +1264,7 @@ added: v8.4.0
12641264

12651265
In `Http2Server`, there is no `'clientError'` event as there is in
12661266
HTTP1. However, there are `'socketError'`, `'sessionError'`, and
1267-
`'streamError'`, for error happened on the socket, session or stream
1267+
`'streamError'`, for error happened on the socket, session, or stream
12681268
respectively.
12691269

12701270
#### Event: 'socketError'
@@ -1857,7 +1857,7 @@ performance.
18571857
There are several types of error conditions that may arise when using the
18581858
`http2` module:
18591859

1860-
Validation Errors occur when an incorrect argument, option or setting value is
1860+
Validation Errors occur when an incorrect argument, option, or setting value is
18611861
passed in. These will always be reported by a synchronous `throw`.
18621862

18631863
State Errors occur when an action is attempted at an incorrect time (for
@@ -2229,7 +2229,7 @@ added: v8.4.0
22292229
* {net.Socket|tls.TLSSocket}
22302230

22312231
Returns a Proxy object that acts as a `net.Socket` (or `tls.TLSSocket`) but
2232-
applies getters, setters and methods based on HTTP/2 logic.
2232+
applies getters, setters, and methods based on HTTP/2 logic.
22332233

22342234
`destroyed`, `readable`, and `writable` properties will be retrieved from and
22352235
set on `request.stream`.
@@ -2601,7 +2601,7 @@ added: v8.4.0
26012601
* {net.Socket|tls.TLSSocket}
26022602

26032603
Returns a Proxy object that acts as a `net.Socket` (or `tls.TLSSocket`) but
2604-
applies getters, setters and methods based on HTTP/2 logic.
2604+
applies getters, setters, and methods based on HTTP/2 logic.
26052605

26062606
`destroyed`, `readable`, and `writable` properties will be retrieved from and
26072607
set on `response.stream`.

doc/api/n-api.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -2257,7 +2257,7 @@ following forms:
22572257
- Named: a simple UTF8-encoded string
22582258
- Integer-Indexed: an index value represented by `uint32_t`
22592259
- JavaScript value: these are represented in N-API by `napi_value`. This can
2260-
be a `napi_value` representing a String, Number or Symbol.
2260+
be a `napi_value` representing a String, Number, or Symbol.
22612261

22622262
N-API values are represented by the type `napi_value`.
22632263
Any N-API call that requires a JavaScript value takes in a `napi_value`.
@@ -3471,8 +3471,8 @@ napi_status napi_get_node_version(napi_env env,
34713471

34723472
Returns `napi_ok` if the API succeeded.
34733473

3474-
This function fills the `version` struct with the major, minor and patch version
3475-
of Node that is currently running, and the `release` field with the
3474+
This function fills the `version` struct with the major, minor, and patch
3475+
version of Node.js that is currently running, and the `release` field with the
34763476
value of [`process.release.name`][`process.release`].
34773477

34783478
The returned buffer is statically allocated and does not need to be freed.

doc/api/os.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -453,7 +453,7 @@ The following signal constants are exported by `os.constants.signals`:
453453
<tr>
454454
<td><code>SIGILL</code></td>
455455
<td>Sent to a process to notify that it has attempted to perform an illegal,
456-
malformed, unknown or privileged instruction.</td>
456+
malformed, unknown, or privileged instruction.</td>
457457
</tr>
458458
<tr>
459459
<td><code>SIGTRAP</code></td>

doc/api/process.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -275,7 +275,7 @@ A process warning is similar to an error in that it describes exceptional
275275
conditions that are being brought to the user's attention. However, warnings
276276
are not part of the normal Node.js and JavaScript error handling flow.
277277
Node.js can emit warnings whenever it detects bad coding practices that could
278-
lead to sub-optimal application performance, bugs or security vulnerabilities.
278+
lead to sub-optimal application performance, bugs, or security vulnerabilities.
279279

280280
The listener function is called with a single `warning` argument whose value is
281281
an `Error` object. There are three key properties that describe the warning:
@@ -1307,7 +1307,7 @@ objects managed by V8. `rss`, Resident Set Size, is the amount of space
13071307
occupied in the main memory device (that is a subset of the total allocated
13081308
memory) for the process, which includes the _heap_, _code segment_ and _stack_.
13091309

1310-
The _heap_ is where objects, strings and closures are stored. Variables are
1310+
The _heap_ is where objects, strings, and closures are stored. Variables are
13111311
stored in the _stack_ and the actual JavaScript code resides in the
13121312
_code segment_.
13131313

doc/api/tls.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ not required and a default ECDHE curve will be used. The `ecdhCurve` property
104104
can be used when creating a TLS Server to specify the list of names of supported
105105
curves to use, see [`tls.createServer()`] for more info.
106106

107-
### ALPN, NPN and SNI
107+
### ALPN, NPN, and SNI
108108

109109
<!-- type=misc -->
110110

doc/releases.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -214,7 +214,7 @@ If you have an error on Windows and need to start again, be aware that you'll ge
214214

215215
ARMv7 takes the longest to compile. Unfortunately ccache isn't as effective on release builds, I think it's because of the additional macro settings that go in to a release build that nullify previous builds. Also most of the release build machines are separate to the test build machines so they don't get any benefit from ongoing compiles between releases. You can expect 1.5 hours for the ARMv7 builder to complete and you should normally wait for this to finish. It is possible to rush a release out if you want and add additional builds later but we normally provide ARMv7 from initial promotion.
216216

217-
You do not have to wait for the ARMv6 / Raspberry PI builds if they take longer than the others. It is only necessary to have the main Linux (x64 and x86), macOS .pkg and .tar.gz, Windows (x64 and x86) .msi and .exe, source, headers and docs (both produced currently by an macOS worker). **If you promote builds _before_ ARM builds have finished, you must repeat the promotion step for the ARM builds when they are ready**.
217+
You do not have to wait for the ARMv6 / Raspberry PI builds if they take longer than the others. It is only necessary to have the main Linux (x64 and x86), macOS .pkg and .tar.gz, Windows (x64 and x86) .msi and .exe, source, headers, and docs (both produced currently by an macOS worker). **If you promote builds _before_ ARM builds have finished, you must repeat the promotion step for the ARM builds when they are ready**.
218218

219219
### 9. Test the Build
220220

0 commit comments

Comments
 (0)