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

doc: clarify http2 docs around class exports #22247

Closed
wants to merge 1 commit into from
Closed

doc: clarify http2 docs around class exports #22247

wants to merge 1 commit into from

Conversation

jasnell
Copy link
Member

@jasnell jasnell commented Aug 10, 2018

Fixes: #21434

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines

@nodejs-github-bot
Copy link
Collaborator

@jasnell build started: https://ci.nodejs.org/blue/organizations/jenkins/node-test-pull-request-lite-pipeline/detail/node-test-pull-request-lite-pipeline/503/pipeline

@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. http2 Issues or PRs related to the http2 subsystem. labels Aug 10, 2018
@jasnell jasnell requested a review from mcollina August 10, 2018 18:50
@jasnell jasnell added the fast-track PRs that do not need to wait for 48 hours to land. label Aug 11, 2018
@jasnell
Copy link
Member Author

jasnell commented Aug 11, 2018

Please 👍 to fast-track

@jasnell jasnell added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Aug 11, 2018
vsemozhetbyt
vsemozhetbyt approved these changes Aug 11, 2018
View reviewed changes
doc/api/http2.md Outdated
@@ -1514,6 +1519,10 @@ In `Http2Server`, there are no `'clientError'` events as there are in
HTTP1. However, there are `'sessionError'`, and `'streamError'` events for
errors emitted on the socket, or from `Http2Session` or `Http2Stream` instances.

Instances of `Http2Server` are created using the
`http2.createServer()` function. the `Http2Server` class is not
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: the -> The.

doc/api/http2.md Outdated
@@ -1629,6 +1638,10 @@ added: v8.4.0

* Extends: {tls.Server}

Instances of `Http2SecureServer` are created using the
`http2.createSecureServer()` function. the `Http2SecureServer` class is not
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ditto.

trivikr
trivikr reviewed Aug 12, 2018
View reviewed changes
doc/api/http2.md Outdated
@@ -1,4 +1,4 @@
# HTTP/2
. th# HTTP/2
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo . th# -> #

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

grr... sigh.

@jasnell jasnell force-pushed the http2-clarify-docs branch from 616491b to 12034bd Compare August 12, 2018 05:25
@jasnell
Copy link
Member Author

jasnell commented Aug 12, 2018

CI-lite: https://ci.nodejs.org/job/node-test-pull-request-lite-pipeline/531/

gdams
gdams approved these changes Aug 12, 2018
View reviewed changes
Copy link
Member

@gdams gdams left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@gdams
Copy link
Member

gdams commented Aug 12, 2018 •
edited
Loading

landed in: d3d5982

@gdams gdams closed this Aug 12, 2018
gdams pushed a commit that referenced this pull request Aug 12, 2018
@jasnell
doc: clarify http2 docs around class exports
d3d5982 
PR-URL: #22247
Fixes: #21434
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: George Adams <george.adams@uk.ibm.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
@rvagg rvagg mentioned this pull request Aug 13, 2018
Merged
rvagg pushed a commit that referenced this pull request Aug 13, 2018
@jasnell @rvagg
doc: clarify http2 docs around class exports
9a31fdc 
PR-URL: #22247
Fixes: #21434
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: George Adams <george.adams@uk.ibm.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
This was referenced Aug 16, 2018
Closed
Closed
Closed
Closed
Closed
Closed
This was referenced Aug 16, 2018
Closed
Closed
Closed
Closed
kjin pushed a commit to kjin/node that referenced this pull request Sep 25, 2018
@jasnell @kjin
doc: clarify http2 docs around class exports
b0aa8f2 
PR-URL: nodejs#22247
Fixes: nodejs#21434
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: George Adams <george.adams@uk.ibm.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
kjin pushed a commit to kjin/node that referenced this pull request Oct 16, 2018
@jasnell @kjin
doc: clarify http2 docs around class exports
411acb7 
PR-URL: nodejs#22247
Fixes: nodejs#21434
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: George Adams <george.adams@uk.ibm.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
BethGriggs pushed a commit that referenced this pull request Oct 17, 2018
@jasnell @BethGriggs
doc: clarify http2 docs around class exports
3980ca1 
Backport-PR-URL: #22850
PR-URL: #22247
Fixes: #21434
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: George Adams <george.adams@uk.ibm.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
@BethGriggs BethGriggs mentioned this pull request Oct 30, 2018
Merged
@beevelop beevelop mentioned this pull request Nov 20, 2018
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gdams gdams gdams approved these changes

@trivikr trivikr trivikr approved these changes

@vsemozhetbyt vsemozhetbyt vsemozhetbyt approved these changes

@cjihrig cjihrig cjihrig approved these changes

@lpinca lpinca lpinca approved these changes

@addaleax addaleax addaleax approved these changes

@mcollina mcollina Awaiting requested review from mcollina

Assignees
No one assigned
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. doc Issues and PRs related to the documentations. fast-track PRs that do not need to wait for 48 hours to land. http2 Issues or PRs related to the http2 subsystem.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
8 participants
@jasnell @nodejs-github-bot @gdams @addaleax @lpinca @cjihrig @vsemozhetbyt @trivikr