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

Syntax error Fix in docs #3715

Closed
wants to merge 1 commit into from
Closed

Syntax error Fix in docs #3715

wants to merge 1 commit into from

Conversation

sacgrover
Copy link

Description

This PR will fix a lot of syntax errors in docs

Type of change

  • Bug fix (non-breaking change which fixes an issue)

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 and tested 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.

@coveralls
Copy link

Coverage Status

Coverage decreased (-2.3%) to 78.032% when pulling 888e2f4 on sacgrover:syntax-error into 67aa557 on ethereum:1.x.

@sacgrover
Copy link
Author

@GregTheGreek @spacesailor24 Could you please review this PR?

@GregTheGreek
Copy link
Contributor

@sacgrover good eye, but the docs are technically correct, let me try and explain.

The notation function(param [, param]) where the , comes after the [ denotes that a parameter is optional. You can see a similar example with the node.js buffer package

For example:

web3.utils.soliditySha3(param1 [, param2, ...])

Tells the user that at a minimum you need param1 supplied for the function to operate correctly.

Does that make sense?

@sacgrover
Copy link
Author

@GregTheGreek Yes, it does. My Bad!! I wasn't aware of this syntax :p Thank You for the explanation.

@sacgrover sacgrover closed this Sep 10, 2020
@GregTheGreek
Copy link
Contributor

@sacgrover Pleasure to help :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants