doc: Make createPushResponse() more detailled. #22366
Conversation
nodejs-github-bot added doc 
| @nodejs/documentation @nodejs/http2 |
doc/api/http2.md Outdated
There was a problem hiding this comment.
Grammar/spelling nit:
For the closed stream, the callback There was a problem hiding this comment.
I meant omit the And, and lower-case the.
There was a problem hiding this comment.
OK. Thanks. I'll also collect other suggestions and do modifications together :)
doc/api/http2.md Outdated
There was a problem hiding this comment.
hmm... the when the stream is closed bit is a bit confusing.
The callback is invoked either (a) after the pushed Http2Stream instead has been created and is ready for use or (b) after the attempt to create the pushed Http2Stream has failed or has been rejected.
There was a problem hiding this comment.
Well……according to what you suggested, I've included these points in my doc modifications :)
jasnell left a comment
jasnell left a comment There was a problem hiding this comment.
Needs additional edits. See comment ^^
doc/api/http2.md Outdated
There was a problem hiding this comment.
Http2Stream->`Http2Stream`- We usually align parameter description lines, so this and the next line need 2 space indent.
There was a problem hiding this comment.
For 1st: I've only meant to add backticks)
doc/api/http2.md Outdated
There was a problem hiding this comment.
Consistency nit: it seems we do not add periods if the description is not a full sentence (see headers description above).
doc/api/http2.md Outdated
There was a problem hiding this comment.
The last bit, , or the state of Http2ServerRequest is closed should be clarified. , or the state of Http2ServerRequest is closed prior to calling the pushStream() method. would be clearer.
| @Maledong can you rebase against master? There is the need of a commit there to make CI pass. |
| @mcollina：OK, I'll rebase and have a submit :) |
Ref: #22322 In summary: We don't know what will return when successful or failure for the callback of the function. So make it more detailled.
| Landed in e7b4ba9 |
We don't know what will return when successful or failure for the callback of the function. So this commit makes it more detailled. PR-URL: #22366 Refs: #22322 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
ghost deleted the | Thanks all! |
We don't know what will return when successful or failure for the callback of the function. So this commit makes it more detailled. PR-URL: #22366 Refs: #22322 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
We don't know what will return when successful or failure for the callback of the function. So this commit makes it more detailled. PR-URL: #22366 Refs: #22322 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
We don't know what will return when successful or failure for the callback of the function. So this commit makes it more detailled. PR-URL: nodejs#22366 Refs: nodejs#22322 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
We don't know what will return when successful or failure for the callback of the function. So this commit makes it more detailled. PR-URL: nodejs#22366 Refs: nodejs#22322 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
We don't know what will return when successful or failure for the callback of the function. So this commit makes it more detailled. Backport-PR-URL: #22850 PR-URL: #22366 Refs: #22322 Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
7 participants
Ref: #22322
In summary:
We don't know what will return when successful or failure for
the callback of the function. So make it more detailled.
make -j4 test(UNIX), orvcbuild test(Windows) passes