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

Document WS clientConfig options in README and RTD #3402

Merged

Conversation

cgewecke
Copy link
Collaborator

@cgewecke cgewecke commented Mar 3, 2020

Description

PR targets #3190 (because it's a Websockets improvement)

Adds documentation about how to configure the Websocket provider's data size limits. This issue was raised recently in #3388 where someone was trying to read a large block from Ropsten.

PR updates WS module README and creates a sub-section about configuring providers in the ReadTheDocs documentation.

Type of change

  • Documentation

Checklist:

  • I have selected the correct base branch.
  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings.
  • Any dependent changes have been merged and published in downstream modules.
  • I ran npm run dtslint with success and extended the tests and types if necessary.
  • I ran npm run test:unit with success.
  • I have executed npm run test:cov and my test cases do cover all lines and branches of the added code.
  • I ran npm run build-all and tested the resulting file/'s from dist folder in a browser.
  • I have updated the CHANGELOG.md file in the root folder.
  • I have tested my code on the live network.

@cgewecke cgewecke added 1.x 1.0 related issues Documentation Relates to project wiki or documentation Review Needed Maintainer(s) need to review labels Mar 3, 2020
@coveralls
Copy link

Coverage Status

Coverage remained the same at 88.116% when pulling df8157e on pri/document-ws-provider-options into 3ab0779 on provider-related-improvements.

@nivida nivida requested a review from holgerd77 March 12, 2020 20:40
Copy link
Collaborator

@holgerd77 holgerd77 left a comment

Choose a reason for hiding this comment

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

LGTM

@holgerd77 holgerd77 merged commit 288582f into provider-related-improvements Mar 20, 2020
@holgerd77 holgerd77 deleted the pri/document-ws-provider-options branch March 20, 2020 16:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1.x 1.0 related issues Documentation Relates to project wiki or documentation Review Needed Maintainer(s) need to review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants