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

Documentation updated #2644

Merged
merged 26 commits into from
Apr 4, 2019
Merged

Documentation updated #2644

merged 26 commits into from
Apr 4, 2019

Conversation

nivida
Copy link
Contributor

@nivida nivida commented Apr 3, 2019

Description

The module constructors where not consistently described.

Fixes #2534 #2514 #2494 #2490 #2383

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 warnings.
  • I have updated or added types for all modules I've changed
  • Any dependent changes have been merged and published in downstream modules.
  • I ran npm run test in the root folder with success and extended the tests if necessary.
  • I ran npm run build in the root folder and tested it in the browser and with node.
  • I ran npm run dtslint in the root folder and tested that all my types are correct
  • I have tested my code on an ethereum test network.

@nivida nivida added In Progress Currently being worked on Documentation Relates to project wiki or documentation labels Apr 3, 2019
@coveralls
Copy link

Coverage Status

Coverage remained the same at 95.374% when pulling b13cc55 on docs/improvements into c9486cb on 1.0.

@coveralls
Copy link

coveralls commented Apr 3, 2019

Coverage Status

Coverage increased (+0.002%) to 95.376% when pulling 4a3a685 on docs/improvements into 340d621 on 1.0.

@coveralls
Copy link

Coverage Status

Coverage remained the same at 95.374% when pulling b13cc55 on docs/improvements into c9486cb on 1.0.

docs/web3-eth.rst Outdated Show resolved Hide resolved
docs/web3-eth.rst Outdated Show resolved Hide resolved
docs/web3-eth.rst Outdated Show resolved Hide resolved
Copy link

@OFRBG OFRBG left a comment

Choose a reason for hiding this comment

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

Good changes! Keep in mind that users reading the docs don't know how the library behaves for "else" cases. If you specify a condition such as "if the address isn't available locally, X happens", the opposite needs to be implicitly clear or specified. Example logic: "[for all cases, Y happens], [only] if the address isn't available locally, X happens."

docs/web3-bzz.rst Outdated Show resolved Hide resolved
@nivida nivida removed the In Progress Currently being worked on label Apr 4, 2019
@nivida nivida added the In Progress Currently being worked on label Apr 4, 2019
@nivida nivida removed the In Progress Currently being worked on label Apr 4, 2019
@nivida nivida merged commit 512c189 into 1.0 Apr 4, 2019
@nivida nivida deleted the docs/improvements branch April 4, 2019 13:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Relates to project wiki or documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants