ethereum / eth-utils

Utility functions for working with ethereum related codebases.
https://eth-utils.readthedocs.io/en/latest/
MIT License
312 stars 148 forks source link

Add docs for all available utilities #254

Closed reedsa closed 11 months ago

reedsa commented 11 months ago

Document utils for conversions, decorators, exception and module loading. text_if_str hexstr_if_str, etc.

What was wrong?

We were missing docs for several utility functions.

Closes #139

How was it fixed?

Filled in docs for utilities that were undocumented.

Todo:

Cute Animal Picture

Put a link to a cute animal picture inside the parenthesis-->

fselmo commented 11 months ago

@reedsa Looks like even though the docs build, there's a table formatting error after making the spacing more homogenous.

When running make build-docs:

.../eth-utils/docs/utilities.rst:811: ERROR: Malformed table.

We could probably leave that table alone in that commit.