Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Wrong v9.4.0 documentation for ServerHttp2Stream#pushStream() #18198

Closed
jinwoo opened this issue Jan 17, 2018 · 3 comments
Closed

Wrong v9.4.0 documentation for ServerHttp2Stream#pushStream() #18198

jinwoo opened this issue Jan 17, 2018 · 3 comments
Labels
doc Issues and PRs related to the documentations. good first issue Issues that are suitable for first-time contributors.

Comments

@jinwoo
Copy link
Contributor

jinwoo commented Jan 17, 2018

  • 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.
@lpinca lpinca added good first issue Issues that are suitable for first-time contributors. doc Issues and PRs related to the documentations. labels Jan 17, 2018
@jasnell
Copy link
Member

jasnell commented 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
Copy link
Contributor

nephross commented Jan 18, 2018 •
edited

@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
Copy link
Member

jasnell commented Jan 18, 2018

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
doc: improve callback documentation of http2Stream.pushstream()
0adb700 
Improve documentation of callback signature of
http2Stream.pushStream() function to align with
the changes made in nodejs#17406.

Fixes: nodejs#18198
Refs: nodejs#17406
@nephross nephross mentioned this issue Jan 19, 2018
Closed
2 tasks
evanlucas pushed a commit that referenced this issue Jan 30, 2018
@nephross @evanlucas
doc: fix documentation of http2Stream.pushstream()
574d3b9 
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 <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
kjin pushed a commit to kjin/node that referenced this issue May 1, 2018
@nephross @kjin
doc: fix documentation of http2Stream.pushstream()
4d7549b 
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 <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
MylesBorins pushed a commit that referenced this issue May 2, 2018
@nephross @MylesBorins
doc: fix documentation of http2Stream.pushstream()
15023c7 
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 <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
MayaLekova pushed a commit to MayaLekova/node that referenced this issue May 8, 2018
@nephross @MayaLekova
doc: fix documentation of http2Stream.pushstream()
8e7a200 
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 <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
doc Issues and PRs related to the documentations. good first issue Issues that are suitable for first-time contributors.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

doc: improve callback documentation of http2Stream.pushstream() nephross/node
4 participants
@jasnell @lpinca @jinwoo @nephross