doc: improve docs for Http2Session:frameError #20236

ryzokuken · 2018-04-23T21:21:53Z

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), or vcbuild test (Windows) passes
documentation is changed or added
commit message follows commit guidelines

/cc @vsemozhetbyt @mcollina @nodejs/http2

ryzokuken · 2018-04-23T21:23:01Z

CI Lite: https://ci.nodejs.org/job/node-test-commit-lite/754/

ryzokuken · 2018-04-23T21:32:55Z

Strange. Rerunning.

ryzokuken · 2018-04-23T21:34:19Z

Reran CI Lite: https://ci.nodejs.org/job/node-test-commit-lite/755/

vsemozhetbyt

LGTM with nits)

vsemozhetbyt · 2018-04-23T21:33:19Z

doc/api/http2.md

@@ -159,18 +159,16 @@ an `Http2Session`.
 added: v8.4.0
 -->

+* `type` {Integer} An integer identifying the frame type.


It seems all three should be {integer} due to type-parser.js.

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.

vsemozhetbyt · 2018-04-23T21:37:06Z

doc/api/http2.md

@@ -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


0 -> `0`?

{integer} The stream id (or `0` if the frame is not associated with a stream).

vsemozhetbyt · 2018-04-23T21:38:20Z

doc/api/http2.md

+* `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).


Indent along with the previous line?

ryzokuken · 2018-04-23T21:39:40Z

Just running LinuxOne: https://ci.nodejs.org/job/node-test-commit-linuxone/643/

vsemozhetbyt · 2018-04-23T21:42:43Z

Please, add 👍 here to approve fast-tracking.

ryzokuken · 2018-04-23T21:43:32Z

@vsemozhetbyt there has to be. It's failing constantly.

Trott

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}.

vsemozhetbyt · 2018-04-23T22:20:56Z

Oh, sorry, I've missed this skimming over the log (and I've added this throwing myself recently 🤦‍♂️ ).

Trott · 2018-04-23T22:36:20Z

Oh, sorry, I've missed this skimming over the log

Yes, it's very easy to miss. No judgment on anyone. Sorry if it came off that way.

vsemozhetbyt · 2018-04-23T22:48:35Z

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 (Error: etc).

Trott · 2018-04-23T22:51:03Z

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 (Error: etc).

Yes, I believe that is correct. Error 1 and Error 2 seem to come up a lot in the relevant error strings so maybe Error (with a space at the end) is worth searching for. And sometimes it even gets buried so early that you have to load the entire log rather than the truncated log that loads by default.

ryzokuken · 2018-04-24T16:00:53Z

@vsemozhetbyt @Trott looks good now?

ryzokuken · 2018-04-24T16:02:07Z

New CI Lite: https://ci.nodejs.org/job/node-test-pull-request-lite/578/

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)

trivikr · 2018-04-24T16:17:17Z

Looks like lint failed in latest CI https://ci.nodejs.org/job/node-test-linter/18460//console

ryzokuken · 2018-04-24T16:21:32Z

@trivikr it did, now it must be fixed.

ryzokuken · 2018-04-24T16:22:08Z

Rerunning linter again: https://ci.nodejs.org/job/node-test-linter/18462/

ryzokuken · 2018-04-24T19:10:18Z

@Trott care taking a look again and changing your review?

Trott · 2018-04-24T20:14:26Z

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/

ryzokuken · 2018-04-24T20:47:05Z

@Trott It passed!

CI is passing now

BridgeAR · 2018-04-25T11:15:50Z

@Trott @trivikr please always add the author-ready label as described in our guide.

ryzokuken · 2018-04-25T17:25:48Z

CI has passed, all reviews are addressed it has been almost 48 hours (it's fast tracked anyway).

Landing this tonight.

ryzokuken · 2018-04-25T17:40:27Z

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: 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>

nodejs-github-bot added doc Issues and PRs related to the documentations. http2 Issues or PRs related to the http2 subsystem. labels Apr 23, 2018

ryzokuken self-assigned this Apr 23, 2018

vsemozhetbyt approved these changes Apr 23, 2018

View reviewed changes

This comment has been minimized.

Sign in to view

vsemozhetbyt added the fast-track PRs that do not need to wait for 48 hours to land. label Apr 23, 2018

Trott previously requested changes Apr 23, 2018

View reviewed changes

ryzokuken force-pushed the docs/http2-3 branch from 8333372 to 2bdc113 Compare April 24, 2018 16:14

doc: improve docs for Http2Session:frameError

2bdc113

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)

trivikr approved these changes Apr 24, 2018

View reviewed changes

BridgeAR approved these changes Apr 25, 2018

View reviewed changes

BridgeAR added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Apr 25, 2018

ryzokuken closed this Apr 25, 2018

MylesBorins mentioned this pull request May 8, 2018

v10.1.0 proposal #20606

Merged

BethGriggs mentioned this pull request Oct 30, 2018

v8.13.0 proposal #23974

Merged

beevelop mentioned this pull request Nov 20, 2018

2018-11-20 Version 8.13.0 'Carbon' (LTS) @MylesBorins prepared by @BethGriggs beevelop/docker-android-nodejs#250

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

doc: improve docs for Http2Session:frameError #20236

doc: improve docs for Http2Session:frameError #20236

ryzokuken commented Apr 23, 2018 •

edited

ryzokuken commented Apr 23, 2018 •

edited

ryzokuken commented Apr 23, 2018

ryzokuken commented Apr 23, 2018

vsemozhetbyt left a comment

vsemozhetbyt Apr 23, 2018 •

edited

Trott Apr 23, 2018

vsemozhetbyt Apr 23, 2018

Trott Apr 23, 2018 •

edited

vsemozhetbyt Apr 23, 2018

ryzokuken commented Apr 23, 2018

This comment has been minimized.

vsemozhetbyt commented Apr 23, 2018

ryzokuken commented Apr 23, 2018

Trott left a comment

vsemozhetbyt commented Apr 23, 2018 •

edited

Trott commented Apr 23, 2018

vsemozhetbyt commented Apr 23, 2018

Trott commented Apr 23, 2018

ryzokuken commented Apr 24, 2018

ryzokuken commented Apr 24, 2018

trivikr commented Apr 24, 2018

ryzokuken commented Apr 24, 2018

ryzokuken commented Apr 24, 2018

ryzokuken commented Apr 24, 2018

Trott commented Apr 24, 2018

ryzokuken commented Apr 24, 2018

BridgeAR commented Apr 25, 2018

ryzokuken commented Apr 25, 2018

ryzokuken commented Apr 25, 2018

doc: improve docs for Http2Session:frameError #20236

doc: improve docs for Http2Session:frameError #20236

Conversation

ryzokuken commented Apr 23, 2018 • edited

Checklist

ryzokuken commented Apr 23, 2018 • edited

ryzokuken commented Apr 23, 2018

ryzokuken commented Apr 23, 2018

vsemozhetbyt left a comment

Choose a reason for hiding this comment

vsemozhetbyt Apr 23, 2018 • edited

Choose a reason for hiding this comment

Trott Apr 23, 2018

Choose a reason for hiding this comment

vsemozhetbyt Apr 23, 2018

Choose a reason for hiding this comment

Trott Apr 23, 2018 • edited

Choose a reason for hiding this comment

vsemozhetbyt Apr 23, 2018

Choose a reason for hiding this comment

ryzokuken commented Apr 23, 2018

This comment has been minimized.

vsemozhetbyt commented Apr 23, 2018

ryzokuken commented Apr 23, 2018

Trott left a comment

Choose a reason for hiding this comment

vsemozhetbyt commented Apr 23, 2018 • edited

Trott commented Apr 23, 2018

vsemozhetbyt commented Apr 23, 2018

Trott commented Apr 23, 2018

ryzokuken commented Apr 24, 2018

ryzokuken commented Apr 24, 2018

trivikr commented Apr 24, 2018

ryzokuken commented Apr 24, 2018

ryzokuken commented Apr 24, 2018

ryzokuken commented Apr 24, 2018

Trott commented Apr 24, 2018

ryzokuken commented Apr 24, 2018

BridgeAR commented Apr 25, 2018

ryzokuken commented Apr 25, 2018

ryzokuken commented Apr 25, 2018

ryzokuken commented Apr 23, 2018 •

edited

ryzokuken commented Apr 23, 2018 •

edited

vsemozhetbyt Apr 23, 2018 •

edited

Trott Apr 23, 2018 •

edited

vsemozhetbyt commented Apr 23, 2018 •

edited