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

Docs: small typos and grammar fixes #3543

Merged
merged 3 commits into from
May 27, 2020
Merged

Docs: small typos and grammar fixes #3543

merged 3 commits into from
May 27, 2020

Conversation

ryanio
Copy link
Collaborator

@ryanio ryanio commented May 27, 2020

Description

This PR fixes some typos, grammar, and broken links in the docs.

Type of change

  • Docs typos/grammar

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 ran npm run test:cov and my test cases cover all the lines and branches of the added code.
  • I ran npm run build-all and tested the resulting files 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.

@ryanio ryanio added Documentation Relates to project wiki or documentation 1.x 1.0 related issues labels May 27, 2020
@coveralls
Copy link

coveralls commented May 27, 2020

Coverage Status

Coverage remained the same at 89.638% when pulling 8dc628d on docs-grammar-fixes into c296b5e on 1.x.

Copy link
Collaborator

@cgewecke cgewecke left a comment

Choose a reason for hiding this comment

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

This is extraordinary!! 💯 💐 🥇

Thanks so much. Dramatically improves legibility. Wonderful!

(Saw a couple tiny stragglers as I went through per comments but am astonished by how much you got cleaned up in this sweep.)

docs/callbacks-promises-events.rst Outdated Show resolved Hide resolved
Ethereum supported Browsers like Mist or MetaMask will have a ``ethereumProvider`` or ``web3.currentProvider`` available. For web3.js, check ``Web3.givenProvider``.

Most Ethereum-supported browsers like MetaMask and TrustWallet have an [EIP-1193](https://eips.ethereum.org/EIPS/eip-1193) compliant provider available at ``window.ethereum``. For web3.js, check ``Web3.givenProvider``.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Great 👍

docs/include_package-core.rst Outdated Show resolved Hide resolved
docs/web3-eth-contract.rst Outdated Show resolved Hide resolved

For further information about the behavior of this method please read the EIP of it: `EIP-1102 <https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1102.md>`_
For more information about the behavior of this method please read `EIP-1102: Opt-in account exposure <https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1102.md>`_.
Copy link
Collaborator

Choose a reason for hiding this comment

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

👍

@holgerd77
Copy link
Collaborator

Yeah, really innocent PR title for this impressive walkthrough! 😄 👍

@ryanio
Copy link
Collaborator Author

ryanio commented May 27, 2020

thanks guys!

@ryanio ryanio merged commit 6cf703a into 1.x May 27, 2020
@holgerd77 holgerd77 deleted the docs-grammar-fixes branch May 28, 2020 06:54
@cgewecke cgewecke added this to Done in v1.2.9 Jun 2, 2020
@ryanio ryanio mentioned this pull request Jun 2, 2020
13 tasks
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
Projects
No open projects
v1.2.9
  
Done
Development

Successfully merging this pull request may close these issues.

None yet

4 participants