doc: improve callback documentation of http2Stream.pushstream()#18258
doc: improve callback documentation of http2Stream.pushstream()#18258nephross wants to merge 3 commits into
Conversation
Improve documentation of callback signature of http2Stream.pushStream() function to align with the changes made in nodejs#17406. Fixes: nodejs#18198 Refs: nodejs#17406
nodejs-github-bot
added
doc
|
@vsemozhetbyt Thank you for pointing it out, found the error and fixed for my local repo, but how do I fix it for the commit already pushed? |
|
Hmm. I thought this would be updated automatically. Maybe you can try to click on this "?" sign here and re-enter the email?
|
| created stream is dependent on. | ||
| * `callback` {Function} Callback that is called once the push stream has been | ||
| initiated. | ||
| * `callback` {Function} Callback that is called once the push stream has been initiated. |
There was a problem hiding this comment.
Nit: please wrap lines at 80 chars.
|
@vsemozhetbyt I don't see the ? unfortunately. I have tried amending the commit author but it is not reflecting upstream. |
| * `callback` {Function} Callback that is called once the push stream has been | ||
| initiated. | ||
| * `callback` {Function} Callback that is called once the push stream has been | ||
| initiated. |
There was a problem hiding this comment.
A nit: I wonder if the hard line break is rendered here due to missing indentation.
| initiated. | ||
| * `err` {Error} | ||
| * `pushStream` {[`ServerHttp2Stream`][]} The returned pushStream object. | ||
| * `headers` {[Headers Object][]} Headers object the pushStream was initiated with. |
There was a problem hiding this comment.
A nit: this line also needs wrapping (currently 84 characters).
Sorry for the pettiness) This can be fixed by a commit lander if it is not convenient for you to amend the commit or push more commits)
There was a problem hiding this comment.
it's all good. My first pr, so I'm here to learn.
|
@nephross That the second commit has the proper info now, I think this suffices for proper PR attribution. Thank you! |
vsemozhetbyt
added
the
fast-track
|
Memo for the lander: I am not sure how will squashing go with the different commit authors and how this will affect the promotion to Contributors, so we may need to be a bit more careful here. |
vsemozhetbyt
added
the
author ready
7 participants
Improve documentation of callback signature of
http2Stream.pushStream() function to align with
the changes made in #17406.
Fixes: #18198
Refs: #17406
Checklist
Affected core subsystem(s)
doc