doc: fix deprecation listing for OutgoingMessage._headers/_headerNames#27574
doc: fix deprecation listing for OutgoingMessage._headers/_headerNames#27574dnalborczyk wants to merge 3 commits intonodejs:masterfrom
Conversation
doc/api/deprecations.md
Outdated
There was a problem hiding this comment.
I think there is nothing wrong with the original. outgoingMessage refers to an instance of OutgoingMessage so outgoingMessage._headers is ok.
There was a problem hiding this comment.
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:
Line 116 in 908292c
I think that consistency is key as well as finding the doc with a search engine (SEO).
There was a problem hiding this comment.
In that case can you please capitalize outgoingMessage? It should be OutgoingMessage.
There was a problem hiding this comment.
ah, good catch! I'll fix that as well ...
There was a problem hiding this comment.
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 :/
|
Can you please make the linter happy? See https://travis-ci.com/nodejs/node/jobs/198041047 |
|
Landed in 91ec5bf, thanks for the PR! 🎉 |
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>
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>
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passes