Repository navigation
docs: fix typos and a stale API reference in lib comments - #7512
Open
fmtappendf wants to merge 1 commit into
Open
fmtappendf wants to merge 1 commit into
fmtappendf wants to merge 1 commit into
Conversation
Signed-off-by: fmtappendf <[email protected]>
krzysdz
approved these changes
Oct 8, 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
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.
Three comment defects in
lib/, each checked against the code it describes.lib/request.js(req.ipJSDoc):The is the remote address on the socket unless→This is the remote address on the socket unless. As written the sentence does not parse.lib/response.js(res.download):// support optional filename, where options may be in it's place→in its place.it'sis the contraction,itsthe possessive.lib/response.js(res.formatJSDoc): the comment says the method usesreq.accepted, "an array of acceptable types ordered by their quality values".req.acceptedwas removed in Express 4 —History.mdlists it under removed APIs ("req.accepted*- usereq.accepts*()instead") — and the implementation callsreq.accepts(keys)and uses the single best match it returns. Corrected to name the call that is actually made.Comment text only: every changed line sits inside a comment and no code line is touched, so behaviour is unchanged.
A fourth instance of the same class,
lib/application.js: "Render the given viewnamename withoptions", is left alone because #7388 already fixes that exact line.Diff is 2 files and 3 comment fixes — small, clean, and non-controversial.