Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: fix deprecation listing for OutgoingMessage._headers/_headerNames #27574

Closed
wants to merge 3 commits into from
Closed

doc: fix deprecation listing for OutgoingMessage._headers/_headerNames #27574

wants to merge 3 commits into from

Conversation

dnalborczyk
Copy link
Contributor

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • tests and/or benchmarks are included
  • documentation is changed or added
  • commit message follows commit guidelines

@nodejs-github-bot nodejs-github-bot added deprecations Issues and PRs related to deprecations. doc Issues and PRs related to the documentations. labels May 6, 2019
lpinca
lpinca reviewed May 6, 2019
View reviewed changes
doc/api/deprecations.md Outdated
@@ -1364,7 +1364,7 @@ The `NODE_REPL_MODE` environment variable is used to set the underlying
removed. Please use `sloppy` instead.

<a id="DEP0066"></a>
### DEP0066: outgoingMessage.\_headers, outgoingMessage.\_headerNames
### DEP0066: outgoingMessage.prototype.\_headers, outgoingMessage.prototype.\_headerNames
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think there is nothing wrong with the original. outgoingMessage refers to an instance of OutgoingMessage so outgoingMessage._headers is ok.

Copy link
Contributor Author

@dnalborczyk dnalborczyk May 6, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@lpinca

compare https://nodejs.org/dist/latest-v12.x/docs/api/deprecations.html#deprecations_dep0066_outgoingmessage_headers_outgoingmessage_headernames with https://nodejs.org/dist/latest-v12.x/docs/api/deprecations.html#deprecations_dep0067_outgoingmessage_prototype_renderheaders

as well as the deprecation message itself:

node/lib/_http_outgoing.js

Line 116 in 908292c

}, 'OutgoingMessage.prototype._headers is deprecated', 'DEP0066'),

I think that consistency is key as well as finding the doc with a search engine (SEO).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh ok, so it's for consistency.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In that case can you please capitalize outgoingMessage? It should be OutgoingMessage.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah, good catch! I'll fix that as well ...

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just noticed another inconsistency: also added prototype to the suggested methods, compare to: https://nodejs.org/dist/latest-v12.x/docs/api/deprecations.html#deprecations_dep0001_http_outgoingmessage_prototype_flush

which also mentions the module name: http.OutgoingMessage :/

@lpinca
Copy link
Member

lpinca commented May 7, 2019

Can you please make the linter happy? See https://travis-ci.com/nodejs/node/jobs/198041047

@BridgeAR
Copy link
Member

Lite CI https://ci.nodejs.org/job/node-test-pull-request-lite-pipeline/3497/

@BridgeAR BridgeAR added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label May 13, 2019
@Trott
Copy link
Member

Trott commented May 19, 2019

Lite CI: https://ci.nodejs.org/job/node-test-pull-request-lite-pipeline/3567/

@addaleax
Copy link
Member

Landed in 91ec5bf, thanks for the PR! 🎉

@addaleax addaleax closed this May 26, 2019
addaleax pushed a commit that referenced this pull request May 26, 2019
@dnalborczyk @addaleax
doc: fix for OutgoingMessage.prototype._headers/_headerNames
91ec5bf 
PR-URL: #27574
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
targos pushed a commit that referenced this pull request May 28, 2019
@dnalborczyk @targos
doc: fix for OutgoingMessage.prototype._headers/_headerNames
9d9b32e 
PR-URL: #27574
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
@targos targos mentioned this pull request Jun 3, 2019
Merged
@dnalborczyk dnalborczyk deleted the patch-3 branch June 5, 2021 02:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@BridgeAR BridgeAR BridgeAR approved these changes

@lpinca lpinca lpinca approved these changes

@Trott Trott Trott approved these changes

@jasnell jasnell jasnell approved these changes

Assignees
No one assigned
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. deprecations Issues and PRs related to deprecations. doc Issues and PRs related to the documentations.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@dnalborczyk @lpinca @BridgeAR @Trott @addaleax @jasnell @nodejs-github-bot