Skip to content

Commit 683f45e

Browse files
doc: fix article usage before vowel-sound acronyms
Several prose references to HTTP, HTTPS, SSL, HPE_HEADER_OVERFLOW and ECMAScript used the article "a" where the acronym starts with a vowel sound and should take "an". The rule is based on pronunciation, not spelling: HTTP is read "aitch-tee-tee-pee", SSL is read "ess-es-el", ECMAScript is read "ek-mah-script", and HPE is read "aitch-pee-ee" — all starting with a vowel sound. Affected files: * doc/api/crypto.md — "disable a SSL 3.0/TLS 1.0 vulnerability" * doc/api/http.md — five occurrences ("a HTTP '400 Bad Request'", "a HTTP '431 Request Header Fields Too Large'", "a HTTP/1.1 102 Processing message", two copies of "use a HTTP parser") plus two references to "a HPE_HEADER_OVERFLOW" * doc/api/http2.md — two code-sample comments reading "// Detects if it is a HTTPS request or HTTP/2" * doc/api/module.md — "compiles a CommonJS, a ECMAScript Module, or a TypeScript module" (only the middle article changes; the adjacent "a CommonJS" and "a TypeScript" are both correct) * doc/api/tls.md — two references to "part of a SSL/TLS handshake" in tlsSocket.getFinished() and tlsSocket.getPeerFinished() No behavior changes, documentation only. Signed-off-by: João Victor Oliveira <joao.oliveira@softtor.com.br>
1 parent f2fda60 commit 683f45e

File tree

5 files changed

+12
-12
lines changed

5 files changed

+12
-12
lines changed

doc/api/crypto.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6645,7 +6645,7 @@ See the [list of SSL OP Flags][] for details.
66456645
</tr>
66466646
<tr>
66476647
<td><code>SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS</code></td>
6648-
<td>Instructs OpenSSL to disable a SSL 3.0/TLS 1.0 vulnerability
6648+
<td>Instructs OpenSSL to disable an SSL 3.0/TLS 1.0 vulnerability
66496649
workaround added in OpenSSL 0.9.6d.</td>
66506650
</tr>
66516651
<tr>

doc/api/http.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1517,7 +1517,7 @@ changes:
15171517
- version: v12.0.0
15181518
pr-url: https://github.com/nodejs/node/pull/25605
15191519
description: The default behavior will return a 431 Request Header
1520-
Fields Too Large if a HPE_HEADER_OVERFLOW error occurs.
1520+
Fields Too Large if an HPE_HEADER_OVERFLOW error occurs.
15211521
- version: v9.4.0
15221522
pr-url: https://github.com/nodejs/node/pull/17672
15231523
description: The `rawPacket` is the current buffer that just parsed. Adding
@@ -1543,8 +1543,8 @@ This event is guaranteed to be passed an instance of the {net.Socket} class,
15431543
a subclass of {stream.Duplex}, unless the user specifies a socket
15441544
type other than {net.Socket}.
15451545

1546-
Default behavior is to try close the socket with a HTTP '400 Bad Request',
1547-
or a HTTP '431 Request Header Fields Too Large' in the case of a
1546+
Default behavior is to try close the socket with an HTTP '400 Bad Request',
1547+
or an HTTP '431 Request Header Fields Too Large' in the case of an
15481548
[`HPE_HEADER_OVERFLOW`][] error. If the socket is not writable or headers
15491549
of the current attached [`http.ServerResponse`][] has been sent, it is
15501550
immediately destroyed.
@@ -2703,7 +2703,7 @@ will result in a [`TypeError`][] being thrown.
27032703
added: v10.0.0
27042704
-->
27052705

2706-
Sends a HTTP/1.1 102 Processing message to the client, indicating that
2706+
Sends an HTTP/1.1 102 Processing message to the client, indicating that
27072707
the request body should be sent.
27082708

27092709
## Class: `http.IncomingMessage`
@@ -3690,7 +3690,7 @@ changes:
36903690
`readableHighWaterMark` and `writableHighWaterMark`. This affects
36913691
`highWaterMark` property of both `IncomingMessage` and `ServerResponse`.
36923692
**Default:** See [`stream.getDefaultHighWaterMark()`][].
3693-
* `insecureHTTPParser` {boolean} If set to `true`, it will use a HTTP parser
3693+
* `insecureHTTPParser` {boolean} If set to `true`, it will use an HTTP parser
36943694
with leniency flags enabled. Using the insecure parser should be avoided.
36953695
See [`--insecure-http-parser`][] for more information.
36963696
**Default:** `false`.
@@ -4001,7 +4001,7 @@ changes:
40014001
request to. **Default:** `'localhost'`.
40024002
* `hostname` {string} Alias for `host`. To support [`url.parse()`][],
40034003
`hostname` will be used if both `host` and `hostname` are specified.
4004-
* `insecureHTTPParser` {boolean} If set to `true`, it will use a HTTP parser
4004+
* `insecureHTTPParser` {boolean} If set to `true`, it will use an HTTP parser
40054005
with leniency flags enabled. Using the insecure parser should be avoided.
40064006
See [`--insecure-http-parser`][] for more information.
40074007
**Default:** `false`

doc/api/http2.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3966,7 +3966,7 @@ const server = createSecureServer(
39663966
).listen(8000);
39673967

39683968
function onRequest(req, res) {
3969-
// Detects if it is a HTTPS request or HTTP/2
3969+
// Detects if it is an HTTPS request or HTTP/2
39703970
const { socket: { alpnProtocol } } = req.httpVersion === '2.0' ?
39713971
req.stream.session : req;
39723972
res.writeHead(200, { 'content-type': 'application/json' });
@@ -3990,7 +3990,7 @@ const server = createSecureServer(
39903990
).listen(4443);
39913991

39923992
function onRequest(req, res) {
3993-
// Detects if it is a HTTPS request or HTTP/2
3993+
// Detects if it is an HTTPS request or HTTP/2
39943994
const { socket: { alpnProtocol } } = req.httpVersion === '2.0' ?
39953995
req.stream.session : req;
39963996
res.writeHead(200, { 'content-type': 'application/json' });

doc/api/module.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -364,7 +364,7 @@ changes:
364364
365365
The module compile cache can be enabled either using the [`module.enableCompileCache()`][]
366366
method or the [`NODE_COMPILE_CACHE=dir`][] environment variable. After it is enabled,
367-
whenever Node.js compiles a CommonJS, a ECMAScript Module, or a TypeScript module, it will
367+
whenever Node.js compiles a CommonJS, an ECMAScript Module, or a TypeScript module, it will
368368
use on-disk [V8 code cache][] persisted in the specified directory to speed up the compilation.
369369
This may slow down the first load of a module graph, but subsequent loads of the same module
370370
graph may get a significant speedup if the contents of the modules do not change.

doc/api/tls.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1212,7 +1212,7 @@ added: v9.9.0
12121212
-->
12131213

12141214
* Returns: {Buffer|undefined} The latest `Finished` message that has been
1215-
sent to the socket as part of a SSL/TLS handshake, or `undefined` if
1215+
sent to the socket as part of an SSL/TLS handshake, or `undefined` if
12161216
no `Finished` message has been sent yet.
12171217

12181218
As the `Finished` messages are message digests of the complete handshake
@@ -1355,7 +1355,7 @@ added: v9.9.0
13551355
-->
13561356

13571357
* Returns: {Buffer|undefined} The latest `Finished` message that is expected
1358-
or has actually been received from the socket as part of a SSL/TLS handshake,
1358+
or has actually been received from the socket as part of an SSL/TLS handshake,
13591359
or `undefined` if there is no `Finished` message so far.
13601360

13611361
As the `Finished` messages are message digests of the complete handshake

0 commit comments

Comments
 (0)