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

4975/net documentation #5258

Merged
merged 9 commits into from
Jul 19, 2022
Merged

4975/net documentation #5258

merged 9 commits into from
Jul 19, 2022

Conversation

luu-alex
Copy link
Contributor

@luu-alex luu-alex commented Jul 16, 2022

#4975

Description

added documentation for the net package. Also added quick doc changes for consisntency with other docs for web3-eth-accounts and net migration docs

Please include a summary of the changes and be sure to follow our Contribution Guidelines.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

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:cov and my test cases cover all the lines and branches of the added code.
  • I ran npm run build with success.
  • I have tested the built dist/web3.min.js in a browser.
  • I have tested my code on the live network.
  • I have checked the Deploy Preview and it looks correct.
  • I have updated the CHANGELOG.md file in the root folder.

@jdevcs
Copy link
Contributor

jdevcs commented Jul 18, 2022

This PR LGTM, except some minor changes required.

@jdevcs jdevcs added the 4.x 4.0 related label Jul 18, 2022
@luu-alex luu-alex requested a review from jdevcs July 19, 2022 01:25
@luu-alex luu-alex merged commit 5662af6 into 4.x Jul 19, 2022
@luu-alex luu-alex deleted the 4975/net-documentation branch July 19, 2022 16:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
4.x 4.0 related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants