Wrong v9.4.0 documentation for ServerHttp2Stream#pushStream()
#18198
Labels
doc
Issues and PRs related to the documentations.
good first issue
Issues that are suitable for first-time contributors.
Comments
lpinca
added
good first issue
|
The callback signature has already been fixed in master and is just waiting for the commit to be pulled in to a release. |
|
@jasnell for clarification, is the doc already updated, but not reflected in master, or is this still considered a good first issue? If it is the latter, I would like to take a stab at it as my first issue and contribution. |
|
It should be fixed in master. If it's not, then a PR is welcome :-) |
nephross
pushed a commit
to nephross/node
that referenced
this issue
Jan 19, 2018
Improve documentation of callback signature of http2Stream.pushStream() function to align with the changes made in nodejs#17406. Fixes: nodejs#18198 Refs: nodejs#17406
2 tasks
evanlucas
pushed a commit
that referenced
this issue
Jan 30, 2018
Improve documentation of callback signature of http2Stream.pushStream() function to align with the changes made in #17406. PR-URL: #18258 Fixes: #18198 Refs: #17406 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: James M Snell <[email protected]>
kjin
pushed a commit
to kjin/node
that referenced
this issue
May 1, 2018
Improve documentation of callback signature of http2Stream.pushStream() function to align with the changes made in nodejs#17406. PR-URL: nodejs#18258 Fixes: nodejs#18198 Refs: nodejs#17406 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: James M Snell <[email protected]>
MylesBorins
pushed a commit
that referenced
this issue
May 2, 2018
Improve documentation of callback signature of http2Stream.pushStream() function to align with the changes made in #17406. Backport-PR-URL: #20456 PR-URL: #18258 Fixes: #18198 Refs: #17406 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: James M Snell <[email protected]>
MayaLekova
pushed a commit
to MayaLekova/node
that referenced
this issue
May 8, 2018
Improve documentation of callback signature of http2Stream.pushStream() function to align with the changes made in nodejs#17406. PR-URL: nodejs#18258 Fixes: nodejs#18198 Refs: nodejs#17406 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: James M Snell <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
#17406 changed the callback function of
ServerHttp2Stream#pushStream()from(pushedStream, headers) => {}to(err, pushedStream, headers) => {}. But the example code in the documentation still says the former: https://nodejs.org/dist/latest-v9.x/docs/api/http2.html#http2_http2stream_pushstream_headers_options_callbackIt'd be great if the example code could be updated. Even better would be to document the callback function's signature in more detail. The document says just
Function, which is not very helpful.The text was updated successfully, but these errors were encountered: