Skip to content
This repository was archived by the owner on Mar 5, 2025. It is now read-only.

Fix fromWei / toWei param and return type documentation #3115

Merged
nivida merged 3 commits into from
Oct 8, 2019
Merged

Fix fromWei / toWei param and return type documentation #3115

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
999546f
Fixing Documentation of fromWei and toWei
Dec 24, 2018
b68fe42
Add unit tests for fromWei/toWei return types
cgewecke Oct 8, 2019
c7a35c0
Merge branch '1.x' into backport/2145
nivida Oct 8, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Fixing Documentation of fromWei and toWei
  • Loading branch information
@cgewecke
fnatic authored and cgewecke committed Oct 8, 2019
commit 999546f3dc6a6f92d35c8d59ed66c84678bd2036
8 changes: 4 additions & 4 deletions docs/web3-utils.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -975,7 +975,7 @@ Converts any `ether value <http://ethdocs.org/en/latest/ether.html>`_ value into
Parameters
----------

1. ``number`` - ``String|Number|BN``: The value.
1. ``number`` - ``String|BN``: The value.
2. ``unit`` - ``String`` (optional, defaults to ``"ether"``): The ether to convert from. Possible units are:
- ``noether``: '0'
- ``wei``: '1'
Expand Down Expand Up @@ -1009,7 +1009,7 @@ Parameters
Returns
-------

``String|BN``: If a number, or string is given it returns a number string, otherwise a `BN.js <https://github.com/indutny/bn.js/>`_ instance.
``String|BN``: If a string is given it returns a number string, otherwise a `BN.js <https://github.com/indutny/bn.js/>`_ instance.

-------
Example
Expand Down Expand Up @@ -1049,7 +1049,7 @@ Converts any `wei <http://ethereum.stackexchange.com/questions/253/the-ether-den
Parameters
----------

1. ``number`` - ``String|Number|BN``: The value in wei.
1. ``number`` - ``String|BN``: The value in wei.
2. ``unit`` - ``String`` (optional, defaults to ``"ether"``): The ether to convert to. Possible units are:
- ``noether``: '0'
- ``wei``: '1'
Expand Down Expand Up @@ -1083,7 +1083,7 @@ Parameters
Returns
-------

``String|BN``: If a number, or string is given it returns a number string, otherwise a `BN.js <https://github.com/indutny/bn.js/>`_ instance.
``String``: It always returns a string number.

-------
Example
Expand Down