Wrong v9.4.0 documentation for ServerHttp2Stream#pushStream() #18198
Description
- Version: v9.4.0
- Platform: Darwin Kernel Version 17.3.0: Thu Nov 9 18:09:22 PST 2017; root:xnu-4570.31.3~1/RELEASE_X86_64 x86_64
- Subsystem: http2
#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_callback
It'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.
Activity
jasnell commentedon Jan 17, 2018
The callback signature has already been fixed in master and is just waiting for the commit to be pulled in to a release.
nephross commentedon Jan 18, 2018
@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.
jasnell commentedon Jan 18, 2018
It should be fixed in master. If it's not, then a PR is welcome :-)
doc: improve callback documentation of http2Stream.pushstream()
doc: fix documentation of http2Stream.pushstream()
doc: fix documentation of http2Stream.pushstream()
doc: fix documentation of http2Stream.pushstream()