doc: fix article usage before vowel-sound acronyms#62696
Open
joao-oliveira-softtor wants to merge 1 commit intonodejs:mainfrom
Open
doc: fix article usage before vowel-sound acronyms#62696joao-oliveira-softtor wants to merge 1 commit intonodejs:mainfrom
joao-oliveira-softtor wants to merge 1 commit intonodejs:mainfrom
Conversation
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>
Collaborator
|
Review requested:
|
avivkeller
approved these changes
Apr 12, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Doc change
Several prose references across the API docs use the article
awhere the following acronym starts with a vowel sound and should takeaninstead. The rule is based on pronunciation, not spelling:Affected occurrences
13 instances across 5 files:
doc/api/crypto.md— 1: "Instructs OpenSSL to disablea SSL 3.0/TLS 1.0vulnerability"doc/api/http.md— 7: fivea HTTP(oneHTTP/1.1, twoHTTP parser, twoHTTP '4xx') plus twoa HPE_HEADER_OVERFLOW errordoc/api/http2.md— 2: two code-sample comments reading// Detects if it is a HTTPS request or HTTP/2doc/api/module.md— 1:compiles a CommonJS, a ECMAScript Module, or a TypeScript module— only the middle article changes;a CommonJSanda TypeScriptare already correctdoc/api/tls.md— 2: bothgetFinished()andgetPeerFinished()describe data "sent/received as part ofa SSL/TLShandshake"Not in scope
errors.md:2043— "The syntax of a MIME is not valid." — MIME is typically spoken as a word ("mime", rhymes with "time"), consonant start, soa MIMEis already correct.a TLS ...occurrences — TLS is "tee-el-es", consonant start, already correct.Verification
Docs-only change. No code, build, or behavior impact.