Skip to content

Commit

Permalink
Clean up warnings when running make notes
Browse files Browse the repository at this point in the history
  • Loading branch information
fselmo committed Sep 27, 2022
1 parent 98d8d4d commit 5ebf50e
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 6 deletions.
7 changes: 4 additions & 3 deletions docs/decoding.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ follows:
>>> decode(['(bytes1,bytes1)'], b'a\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00b\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00')
((b'a', b'b'),)

The :any:`decode` function provides an API for decoding binary values for ABI types into python values. It accepts a
sequence of ABI type strings as the first argument and the binary data to be decoded, as a python ``bytes`` or
``bytearray`` value, as the second argument.
The :py:meth:`eth_abi.decoding.BaseDecoder.decode` function provides an API for
decoding binary values for ABI types into python values. It accepts a sequence of
ABI type strings as the first argument and the binary data to be decoded, as a python
``bytes`` or ``bytearray`` value, as the second argument.
7 changes: 4 additions & 3 deletions docs/encoding.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,10 @@ follows:
b'a\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00b\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00'


The :any:`encode` function provides an API for encoding python values into binary values for ABI types. It accepts a
sequence of ABI type strings as the first argument and a sequence of python values to be encoded into the respective ABI
types as the second argument.
The :py:meth:`eth_abi.encoding.BaseEncoder.encode` function provides an API for
encoding python values into binary values for ABI types. It accepts a sequence of ABI
type strings as the first argument and a sequence of python values to be encoded into
the respective ABI types as the second argument.

Checking for Encodability
-------------------------
Expand Down

0 comments on commit 5ebf50e

Please sign in to comment.