Document Formatting

[danforbes]

Document formatting - closes #6743

[github-actions[bot]]

Bundle Stats

Hey there, this message comes from a GitHub action that helps you and reviewers to understand how these changes affect the size of this project's bundle.

As this PR is updated, I'll keep you updated on how the bundle size is impacted.

Total

Files count	Total bundle size	% Changed
10	639.62 kB	0%

Changeset

File	Δ	Size
../web3-utils/lib/commonjs/formatter.js	📈 +527 B (+3.67%)	14.01 kB → 14.52 kB

View detailed bundle breakdown

Added

No assets were added

Removed

No assets were removed

Bigger

No assets were bigger

Smaller

No assets were smaller

Unchanged

Asset	File Size	% Changed
web3.min.js	620.22 kB	0%
../lib/commonjs/index.d.ts	8.69 kB	0%
../lib/commonjs/accounts.d.ts	3.89 kB	0%
../lib/commonjs/types.d.ts	2.67 kB	0%
../lib/commonjs/web3.d.ts	1.38 kB	0%
../lib/commonjs/web3_eip6963.d.ts	1.28 kB	0%
../lib/commonjs/abi.d.ts	999 B	0%
../lib/commonjs/eth.exports.d.ts	280 B	0%
../lib/commonjs/providers.exports.d.ts	183 B	0%
../lib/commonjs/version.d.ts	60 B	0%

[danforbes]

@danforbes In this doc PR, I'll suggest to create formatting guide using functions in packages like web3.eth.getBlockNumber(..), ...

@jdevcs can you clarify your suggestion? The existing guide uses web3.eth.getBlock as an example. Do you think it would be better to replace that example with one that uses web3.eth.getBlockNumber?

[codecov[bot]]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 94.44%. Comparing base (b86d8ca) to head (608d0b9). Report is 1 commits behind head on 4.x.

Additional details and impacted files

@@           Coverage Diff           @@
##              4.x    #7222   +/-   ##
=======================================
  Coverage   94.44%   94.44%           
=======================================
  Files         216      216           
  Lines        8454     8454           
  Branches     2335     2335           
=======================================
  Hits         7984     7984           
  Misses        470      470           

Flag	Coverage Δ
UnitTests	94.44% <ø> (ø)

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

[jdevcs]

@danforbes In this doc PR, I'll suggest to create formatting guide using functions in packages like web3.eth.getBlockNumber(..), ...

@jdevcs can you clarify your suggestion? The existing guide uses web3.eth.getBlock as an example. Do you think it would be better to replace that example with one that uses web3.eth.getBlockNumber?

what do you think for adding one example for each of sub sections specially for formatting numbers using web3.eth.getBlockNumber

[danforbes]

what do you think for adding one example for each of sub sections specially for formatting numbers using web3.eth.getBlockNumber

@jdevcs is this what you had in mind? https://f3916c2c.web3-js-docs.pages.dev/guides/getting_started/return-formats

[jdevcs]

what do you think for adding one example for each of sub sections specially for formatting numbers using web3.eth.getBlockNumber

@jdevcs is this what you had in mind? https://f3916c2c.web3-js-docs.pages.dev/guides/getting_started/return-formats

yes, looks very good,