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

docs: epsilon builtin #3552

Merged
merged 1 commit into from
Aug 5, 2023
Merged
Changes from all commits
Commits
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
18 changes: 18 additions & 0 deletions docs/built-in-functions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -573,6 +573,24 @@ Math
>>> ExampleContract.foo(3.1337)
4
.. py:function:: epsilon(typename) -> Any
Returns the smallest non-zero value for a decimal type.

* ``typename``: Name of the decimal type (currently only ``decimal``)

.. code-block:: python
@external
@view
def foo() -> decimal:
return epsilon(decimal)
.. code-block:: python
>>> ExampleContract.foo()
Decimal('1E-10')
.. py:function:: floor(value: decimal) -> int256
Round a decimal down to the nearest integer.
Expand Down