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

doc: add docs of createContractAddress #7421

Merged
merged 3 commits into from
Dec 11, 2024
Merged

doc: add docs of createContractAddress #7421

merged 3 commits into from
Dec 11, 2024

Conversation

jasonandjay
Copy link
Contributor

Description

Added the documentation for createContractAddress just like #7418:

Included JSDoc comments directly in the function definition.

Type of change

  • Documentation (changes that only address relatively minor typographical errors are not accepted)

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 lint with success and extended the tests and types if necessary.
  • I ran npm run test:unit with success.
  • I ran npm run test:coverage 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.
  • I have linked Issue(s) with this PR in "Linked Issues" menu.

packages/web3-eth-contract/src/utils.ts Outdated Show resolved Hide resolved
packages/web3-eth-contract/src/utils.ts Outdated Show resolved Hide resolved
Copy link

codecov bot commented Dec 11, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.54%. Comparing base (fa5ce5b) to head (ae1936a).
Report is 1 commits behind head on 4.x.

Additional details and impacted files
@@           Coverage Diff           @@
##              4.x    #7421   +/-   ##
=======================================
  Coverage   94.54%   94.54%           
=======================================
  Files         218      218           
  Lines        8637     8637           
  Branches     2364     2364           
=======================================
  Hits         8166     8166           
  Misses        471      471           
Flag Coverage Δ
UnitTests 94.54% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

@danforbes danforbes merged commit ae99434 into web3:4.x Dec 11, 2024
52 of 54 checks passed
@ayanwaar
Copy link

11d1416

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