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.

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: cleanup pendingSettingsAck docs #28388

Merged
merged 1 commit into from
Jun 25, 2019
Merged

doc: cleanup pendingSettingsAck docs #28388

merged 1 commit into from
Jun 25, 2019

Conversation

cjihrig
Copy link
Contributor

@cjihrig cjihrig commented Jun 22, 2019

This commit rephrases the first sentence of the http2 session pendingSettingsAck property docs. It also formats SETTINGS consistently.

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

@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 Jun 22, 2019
@cjihrig
Copy link
Contributor Author

cjihrig commented Jun 24, 2019

doc/api/http2.md Outdated
Indicates whether or not the `Http2Session` is currently waiting for an
acknowledgment for a sent `SETTINGS` frame. Will be `true` after calling the
`http2session.settings()` method. Will be `false` once all sent SETTINGS
Indicates whether or not the `Http2Session` is currently waiting for
Copy link
Member

Choose a reason for hiding this comment

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

Totally optional micro-suggestion:

Suggested change
Indicates whether or not the `Http2Session` is currently waiting for
Indicates whether the `Http2Session` is currently waiting for

This commit rephrases the first sentence of the http2 session
pendingSettingsAck property docs. It also formats SETTINGS
consistently.

PR-URL: nodejs#28388
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
@cjihrig cjihrig merged commit a7e0155 into nodejs:master Jun 25, 2019
@cjihrig cjihrig deleted the pending branch June 25, 2019 12:30
targos pushed a commit that referenced this pull request Jul 2, 2019
This commit rephrases the first sentence of the http2 session
pendingSettingsAck property docs. It also formats SETTINGS
consistently.

PR-URL: #28388
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
@targos targos mentioned this pull request Jul 2, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations. http2 Issues or PRs related to the http2 subsystem.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants