From 683f45e4ac471dc99c4b5d382d1b4a5f9cb98260 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20Victor=20Oliveira?= Date: Sat, 11 Apr 2026 19:38:24 -0300 Subject: [PATCH] doc: fix article usage before vowel-sound acronyms MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 --- doc/api/crypto.md | 2 +- doc/api/http.md | 12 ++++++------ doc/api/http2.md | 4 ++-- doc/api/module.md | 2 +- doc/api/tls.md | 4 ++-- 5 files changed, 12 insertions(+), 12 deletions(-) diff --git a/doc/api/crypto.md b/doc/api/crypto.md index 84e5520186dbb6..8f4fd9a6d56ed7 100644 --- a/doc/api/crypto.md +++ b/doc/api/crypto.md @@ -6645,7 +6645,7 @@ See the [list of SSL OP Flags][] for details. SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS - Instructs OpenSSL to disable a SSL 3.0/TLS 1.0 vulnerability + Instructs OpenSSL to disable an SSL 3.0/TLS 1.0 vulnerability workaround added in OpenSSL 0.9.6d. diff --git a/doc/api/http.md b/doc/api/http.md index 8ac1ed166103b0..3b36fef4eca0bd 100644 --- a/doc/api/http.md +++ b/doc/api/http.md @@ -1517,7 +1517,7 @@ changes: - version: v12.0.0 pr-url: https://github.com/nodejs/node/pull/25605 description: The default behavior will return a 431 Request Header - Fields Too Large if a HPE_HEADER_OVERFLOW error occurs. + Fields Too Large if an HPE_HEADER_OVERFLOW error occurs. - version: v9.4.0 pr-url: https://github.com/nodejs/node/pull/17672 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, a subclass of {stream.Duplex}, unless the user specifies a socket type other than {net.Socket}. -Default behavior is to try close the socket with a HTTP '400 Bad Request', -or a HTTP '431 Request Header Fields Too Large' in the case of a +Default behavior is to try close the socket with an HTTP '400 Bad Request', +or an HTTP '431 Request Header Fields Too Large' in the case of an [`HPE_HEADER_OVERFLOW`][] error. If the socket is not writable or headers of the current attached [`http.ServerResponse`][] has been sent, it is immediately destroyed. @@ -2703,7 +2703,7 @@ will result in a [`TypeError`][] being thrown. added: v10.0.0 --> -Sends a HTTP/1.1 102 Processing message to the client, indicating that +Sends an HTTP/1.1 102 Processing message to the client, indicating that the request body should be sent. ## Class: `http.IncomingMessage` @@ -3690,7 +3690,7 @@ changes: `readableHighWaterMark` and `writableHighWaterMark`. This affects `highWaterMark` property of both `IncomingMessage` and `ServerResponse`. **Default:** See [`stream.getDefaultHighWaterMark()`][]. - * `insecureHTTPParser` {boolean} If set to `true`, it will use a HTTP parser + * `insecureHTTPParser` {boolean} If set to `true`, it will use an HTTP parser with leniency flags enabled. Using the insecure parser should be avoided. See [`--insecure-http-parser`][] for more information. **Default:** `false`. @@ -4001,7 +4001,7 @@ changes: request to. **Default:** `'localhost'`. * `hostname` {string} Alias for `host`. To support [`url.parse()`][], `hostname` will be used if both `host` and `hostname` are specified. - * `insecureHTTPParser` {boolean} If set to `true`, it will use a HTTP parser + * `insecureHTTPParser` {boolean} If set to `true`, it will use an HTTP parser with leniency flags enabled. Using the insecure parser should be avoided. See [`--insecure-http-parser`][] for more information. **Default:** `false` diff --git a/doc/api/http2.md b/doc/api/http2.md index 759430a0f34cd8..c4854f270f5b8a 100644 --- a/doc/api/http2.md +++ b/doc/api/http2.md @@ -3966,7 +3966,7 @@ const server = createSecureServer( ).listen(8000); function onRequest(req, res) { - // Detects if it is a HTTPS request or HTTP/2 + // Detects if it is an HTTPS request or HTTP/2 const { socket: { alpnProtocol } } = req.httpVersion === '2.0' ? req.stream.session : req; res.writeHead(200, { 'content-type': 'application/json' }); @@ -3990,7 +3990,7 @@ const server = createSecureServer( ).listen(4443); function onRequest(req, res) { - // Detects if it is a HTTPS request or HTTP/2 + // Detects if it is an HTTPS request or HTTP/2 const { socket: { alpnProtocol } } = req.httpVersion === '2.0' ? req.stream.session : req; res.writeHead(200, { 'content-type': 'application/json' }); diff --git a/doc/api/module.md b/doc/api/module.md index ebede62eeca3a4..b680e0f9932c6a 100644 --- a/doc/api/module.md +++ b/doc/api/module.md @@ -364,7 +364,7 @@ changes: The module compile cache can be enabled either using the [`module.enableCompileCache()`][] method or the [`NODE_COMPILE_CACHE=dir`][] environment variable. After it is enabled, -whenever Node.js compiles a CommonJS, a ECMAScript Module, or a TypeScript module, it will +whenever Node.js compiles a CommonJS, an ECMAScript Module, or a TypeScript module, it will use on-disk [V8 code cache][] persisted in the specified directory to speed up the compilation. This may slow down the first load of a module graph, but subsequent loads of the same module graph may get a significant speedup if the contents of the modules do not change. diff --git a/doc/api/tls.md b/doc/api/tls.md index dc4719d391d003..5d11e2c53eada0 100644 --- a/doc/api/tls.md +++ b/doc/api/tls.md @@ -1212,7 +1212,7 @@ added: v9.9.0 --> * Returns: {Buffer|undefined} The latest `Finished` message that has been - sent to the socket as part of a SSL/TLS handshake, or `undefined` if + sent to the socket as part of an SSL/TLS handshake, or `undefined` if no `Finished` message has been sent yet. As the `Finished` messages are message digests of the complete handshake @@ -1355,7 +1355,7 @@ added: v9.9.0 --> * Returns: {Buffer|undefined} The latest `Finished` message that is expected - or has actually been received from the socket as part of a SSL/TLS handshake, + or has actually been received from the socket as part of an SSL/TLS handshake, or `undefined` if there is no `Finished` message so far. As the `Finished` messages are message digests of the complete handshake