FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

doc: fix article usage before vowel-sound acronyms · nodejs/node@c39d5fc · GitHub

/ node Public

Commit c39d5fc

Browse files
joao-oliveira-softtor
authored and
aduh95
committed
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> PR-URL: #62696 Reviewed-By: Aviv Keller <me@aviv.sh> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Akhil Marsonya <akhil.marsonya27@gmail.com> Reviewed-By: Jacob Smith <jacob@frende.me>
1 parent 398261f commit c39d5fc

5 files changed

Lines changed: 12 additions & 12 deletions

File tree

‎doc/api/crypto.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6615,7 +6615,7 @@ See the [list of SSL OP Flags][] for details.
66156615
</tr>
66166616
<tr>
66176617
<td><code>SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS</code></td>
6618-
<td>Instructs OpenSSL to disable a SSL 3.0/TLS 1.0 vulnerability
6618+
<td>Instructs OpenSSL to disable an SSL 3.0/TLS 1.0 vulnerability
66196619
workaround added in OpenSSL 0.9.6d.</td>
66206620
</tr>
66216621
<tr>

‎doc/api/http.md‎

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

1542-
Default behavior is to try close the socket with a HTTP '400 Bad Request',
1543-
or a HTTP '431 Request Header Fields Too Large' in the case of a
1542+
Default behavior is to try close the socket with an HTTP '400 Bad Request',
1543+
or an HTTP '431 Request Header Fields Too Large' in the case of an
15441544
[`HPE_HEADER_OVERFLOW`][] error. If the socket is not writable or headers
15451545
of the current attached [`http.ServerResponse`][] has been sent, it is
15461546
immediately destroyed.
@@ -2710,7 +2710,7 @@ response.writeInformation(110, { 'X-Progress': '50%' });
27102710
added: v10.0.0
27112711
-->
27122712

2713-
Sends a HTTP/1.1 102 Processing message to the client, indicating that
2713+
Sends an HTTP/1.1 102 Processing message to the client, indicating that
27142714
the request body should be sent.
27152715

27162716
## Class: `http.IncomingMessage`
@@ -3693,7 +3693,7 @@ changes:
36933693
`readableHighWaterMark` and `writableHighWaterMark`. This affects
36943694
`highWaterMark` property of both `IncomingMessage` and `ServerResponse`.
36953695
**Default:** See [`stream.getDefaultHighWaterMark()`][].
3696-
* `insecureHTTPParser` {boolean} If set to `true`, it will use a HTTP parser
3696+
* `insecureHTTPParser` {boolean} If set to `true`, it will use an HTTP parser
36973697
with leniency flags enabled. Using the insecure parser should be avoided.
36983698
See [`--insecure-http-parser`][] for more information.
36993699
**Default:** `false`.
@@ -4004,7 +4004,7 @@ changes:
40044004
request to. **Default:** `'localhost'`.
40054005
* `hostname` {string} Alias for `host`. To support [`url.parse()`][],
40064006
`hostname` will be used if both `host` and `hostname` are specified.
4007-
* `insecureHTTPParser` {boolean} If set to `true`, it will use a HTTP parser
4007+
* `insecureHTTPParser` {boolean} If set to `true`, it will use an HTTP parser
40084008
with leniency flags enabled. Using the insecure parser should be avoided.
40094009
See [`--insecure-http-parser`][] for more information.
40104010
**Default:** `false`

‎doc/api/http2.md‎

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

39623962
function onRequest(req, res) {
3963-
// Detects if it is a HTTPS request or HTTP/2
3963+
// Detects if it is an HTTPS request or HTTP/2
39643964
const { socket: { alpnProtocol } } = req.httpVersion === '2.0' ?
39653965
req.stream.session : req;
39663966
res.writeHead(200, { 'content-type': 'application/json' });
@@ -3984,7 +3984,7 @@ const server = createSecureServer(
39843984
).listen(4443);
39853985

39863986
function onRequest(req, res) {
3987-
// Detects if it is a HTTPS request or HTTP/2
3987+
// Detects if it is an HTTPS request or HTTP/2
39883988
const { socket: { alpnProtocol } } = req.httpVersion === '2.0' ?
39893989
req.stream.session : req;
39903990
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
@@ -400,7 +400,7 @@ changes:
400400
401401
The module compile cache can be enabled either using the [`module.enableCompileCache()`][]
402402
method or the [`NODE_COMPILE_CACHE=dir`][] environment variable. After it is enabled,
403-
whenever Node.js compiles a CommonJS, a ECMAScript Module, or a TypeScript module, it will
403+
whenever Node.js compiles a CommonJS, an ECMAScript Module, or a TypeScript module, it will
404404
use on-disk [V8 code cache][] persisted in the specified directory to speed up the compilation.
405405
This may slow down the first load of a module graph, but subsequent loads of the same module
406406
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)
Back | FazBrowse Home | New Git URL