-
Notifications
You must be signed in to change notification settings - Fork 29k
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.
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
doc: improve docs for Http2Session:frameError #20236
Conversation
Strange. Rerunning. |
Reran CI Lite: https://ci.nodejs.org/job/node-test-commit-lite/755/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM with nits)
doc/api/http2.md
Outdated
@@ -159,18 +159,16 @@ an `Http2Session`. | |||
added: v8.4.0 | |||
--> | |||
|
|||
* `type` {Integer} An integer identifying the frame type. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It seems all three should be {integer}
due to type-parser.js.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit: You don't need to tell the reader it's an integer if it already has the type {integer}
. So instead of everything starting with {integer} An integer identifying the frame type.
, just say {integer} The frame type.
doc/api/http2.md
Outdated
@@ -159,18 +159,16 @@ an `Http2Session`. | |||
added: v8.4.0 | |||
--> | |||
|
|||
* `type` {Integer} An integer identifying the frame type. | |||
* `code` {Integer} An integer identifying the error code. | |||
* `id` {Integer} An integer identifying the stream (or 0 if the frame is not |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
0
-> `0`
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
{integer} The stream id (or `0` if the frame is not associated with a stream).
doc/api/http2.md
Outdated
* `type` {Integer} An integer identifying the frame type. | ||
* `code` {Integer} An integer identifying the error code. | ||
* `id` {Integer} An integer identifying the stream (or 0 if the frame is not | ||
associated with a stream). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Indent along with the previous line?
Just running LinuxOne: https://ci.nodejs.org/job/node-test-commit-linuxone/643/ |
This comment has been minimized.
This comment has been minimized.
Please, add 👍 here to approve fast-tracking. |
@vsemozhetbyt there has to be. It's failing constantly. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nothing is wrong with LinuxOne. The problem is this PR. It's failing at the doc-building step on the use of {Integer}
instead of {integer}
.
Oh, sorry, I've missed this skimming over the log (and I've added this throwing myself recently 🤦♂️ ). |
Yes, it's very easy to miss. No judgment on anyone. Sorry if it came off that way. |
If I get this right, the docs are built in parallel with other tasks and the error message is interleaved with other output in this case. So we need to search for keywords in the page ( |
Yes, I believe that is correct. |
@vsemozhetbyt @Trott looks good now? |
Improve documentation regarding the callback parameters for the frameError event for instances of Http2Session, making it inline with the currently accepted structure, like the rest of the documentation. Refs: nodejs/help#877 (comment)
Looks like lint failed in latest CI https://ci.nodejs.org/job/node-test-linter/18460//console |
@trivikr it did, now it must be fixed. |
Rerunning linter again: https://ci.nodejs.org/job/node-test-linter/18462/ |
@Trott care taking a look again and changing your review? |
Lite CI (because changes have been made since the last one and only the linter was re-run): https://ci.nodejs.org/job/node-test-pull-request-lite/579/ |
@Trott It passed! |
CI has passed, all reviews are addressed it has been almost 48 hours (it's fast tracked anyway). Landing this tonight. |
Landed in 2a30bfe |
Improve documentation regarding the callback parameters for the frameError event for instances of Http2Session, making it inline with the currently accepted structure, like the rest of the documentation. Refs: nodejs/help#877 (comment) PR-URL: #20236 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Improve documentation regarding the callback parameters for the frameError event for instances of Http2Session, making it inline with the currently accepted structure, like the rest of the documentation. Refs: nodejs/help#877 (comment) PR-URL: #20236 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Improve documentation regarding the callback parameters for the frameError event for instances of Http2Session, making it inline with the currently accepted structure, like the rest of the documentation. Refs: nodejs/help#877 (comment) PR-URL: nodejs#20236 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Improve documentation regarding the callback parameters for the frameError event for instances of Http2Session, making it inline with the currently accepted structure, like the rest of the documentation. Refs: nodejs/help#877 (comment) PR-URL: nodejs#20236 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Improve documentation regarding the callback parameters for the frameError event for instances of Http2Session, making it inline with the currently accepted structure, like the rest of the documentation. Refs: nodejs/help#877 (comment) PR-URL: nodejs#20236 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Improve documentation regarding the callback parameters for the frameError event for instances of Http2Session, making it inline with the currently accepted structure, like the rest of the documentation. Refs: nodejs/help#877 (comment) PR-URL: nodejs#20236 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Improve documentation regarding the callback parameters for the frameError event for instances of Http2Session, making it inline with the currently accepted structure, like the rest of the documentation. Refs: nodejs/help#877 (comment) Backport-PR-URL: #22850 PR-URL: #20236 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Improve documentation regarding the callback parameters for the
frameError event for instances of Http2Session, making it inline with
the currently accepted structure, like the rest of the documentation.
Refs: nodejs/help#877 (comment)
Checklist
make -j4 test
(UNIX), orvcbuild test
(Windows) passes/cc @vsemozhetbyt @mcollina @nodejs/http2