doc: fix http.ClientRequest method descriptions #15163
Closed
Conversation
This file contains 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
nodejs-github-bot
added
doc
benjamingr
reviewed
Sep 3, 2017
There was a problem hiding this comment.
I'm not sure the terminology of looking at request headers as "technically queued" is useful when explaining the concept.
That said, it's what we're currently doing in HTTP1 responses so I'm not going to block on it.
Could you please change the text in:
The header is still mutable using the setHeader(name, value), getHeader(name), removeHeader(name) API. The actual header will be sent along with the first data chunk or when closing the connection.
to links to the new method?
doc/api/http.md
Outdated
| * `name` {string} | ||
| * `value` {string} | ||
|
|
||
| Sets a single header value for implicit headers. If this header already exists in the to-be-sent headers, its value will be replaced. Use an array of strings here if you need to send multiple headers with the same name. |
There was a problem hiding this comment.
I'm not sure the meaning of 'for implicit headers' is clear enough.
doc/api/http.md
Outdated
|
|
||
| * `name` {string} | ||
|
|
||
| Removes a header that's queued for implicit sending. |
There was a problem hiding this comment.
I don't think 'queued for implicit sending' is terminology I want to expose our users to.
doc/api/http.md
Outdated
| * `name` {string} | ||
| * Returns: {string} | ||
|
|
||
| Reads out a header that's already been queued. Note that the name is case insensitive. |
There was a problem hiding this comment.
'Reads out a header on the request' maybe?
antoine-amara
force-pushed
the
doc-#15048-clientrequest-documentation-inconsistencies
branch
from
cbbd33e
to
6670c2b
Compare
|
@benjamingr, I commit new changes, thanks for your first review. |
jasnell
reviewed
Sep 7, 2017
doc/api/http.md
Outdated
| * `name` {string} | ||
| * `value` {string} | ||
|
|
||
| Sets a single header value for headers object. If this header already exists in the to-be-sent headers, its value will be replaced. Use an array of strings here if you need to send multiple headers with the same name. |
There was a problem hiding this comment.
couple of things here:
- This is a long line. Please line wrap at <= 80 chars
- Please avoid the use of
youin the docs.
jasnell
requested changes
Sep 7, 2017
antoine-amara
force-pushed
the
doc-#15048-clientrequest-documentation-inconsistencies
branch
2 times, most recently
from
6670c2b
to
44c0877
Compare
BridgeAR
approved these changes
Sep 9, 2017
|
I think everything got addressed |
|
@BridgeAR, @jasnell, @benjamingr , should I rebase master and push the new commits into this branch before the next review ? |
|
rebasing is always a good idea! :-) |
jasnell
approved these changes
Sep 13, 2017
|
ok so I rebase before the merge, I leave a comment after I push |
antoine-amara
force-pushed
the
doc-#15048-clientrequest-documentation-inconsistencies
branch
from
44c0877
to
bcdc178
Compare
|
Ok, @BridgeAR, @jasnell, @benjamingr, the branch is up to date :) thanks for your reviews. |
fix documentation for methods getHeader, setHeader and removeHeader for http.ClientRequest class. The documentation said these functions can be called but they're wasn't describe into the API description yet. add parameters and general description for each methods. Fixes: nodejs#15048
antoine-amara
force-pushed
the
doc-#15048-clientrequest-documentation-inconsistencies
branch
from
bcdc178
to
adc1d28
Compare
jasnell
pushed a commit
that referenced
this pull request
Sep 15, 2017
fix documentation for methods getHeader, setHeader and removeHeader for http.ClientRequest class. The documentation said these functions can be called but they're wasn't describe into the API description yet. add parameters and general description for each methods. PR-URL: #15163 Fixes: #15048 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
|
Landed in ca2c73c |
addaleax
pushed a commit
to addaleax/ayo
that referenced
this pull request
Sep 17, 2017
fix documentation for methods getHeader, setHeader and removeHeader for http.ClientRequest class. The documentation said these functions can be called but they're wasn't describe into the API description yet. add parameters and general description for each methods. PR-URL: nodejs/node#15163 Fixes: nodejs/node#15048 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
jasnell
pushed a commit
that referenced
this pull request
Sep 20, 2017
fix documentation for methods getHeader, setHeader and removeHeader for http.ClientRequest class. The documentation said these functions can be called but they're wasn't describe into the API description yet. add parameters and general description for each methods. PR-URL: #15163 Fixes: #15048 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Qard
pushed a commit
to Qard/ayo
that referenced
this pull request
Sep 21, 2017
fix documentation for methods getHeader, setHeader and removeHeader for http.ClientRequest class. The documentation said these functions can be called but they're wasn't describe into the API description yet. add parameters and general description for each methods. PR-URL: nodejs/node#15163 Fixes: nodejs/node#15048 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
decareano
added a commit
to decareano/node
that referenced
this pull request
Sep 22, 2017
doc: fix http.ClientRequest method descriptions fix documentation for methods getHeader, setHeader and removeHeader for http.ClientRequest class. The documentation said these functions can be called but they're wasn't describe into the API description yet. add parameters and general description for each methods. PR-URL: nodejs#15163 Fixes: nodejs#15048 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> assert: use Same-value equality in deepStrictEqual PR-URL: nodejs#15398 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Rich Trott <rtrott@gmail.com> formatting fix and scar deleted
antoine-amara
deleted the
doc-#15048-clientrequest-documentation-inconsistencies
branch
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.
fix documentation for methods getHeader, setHeader and removeHeader
for http.ClientRequest class. The documentation said these functions
can be called but they're wasn't describe into the API description yet.
add parameters and general description for each methods.
Fixes: #15048
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passesAffected core subsystem(s)