Skip to content

Commit c4d07a3

Browse files
committed
update contract.encode_abi signature in docs and migration guide
1 parent 26b5e85 commit c4d07a3

File tree

3 files changed

+4
-3
lines changed

3 files changed

+4
-3
lines changed

docs/migration.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -333,7 +333,7 @@ Miscellaneous Changes
333333
without checking if the ``geth.ipc`` file exists.
334334
- ``Web3.is_address()`` returns ``True`` for non-checksummed addresses.
335335
- ``Contract.encodeABI()`` has been renamed to ``Contract.encode_abi()``. The ``fn_name``
336-
argument has been changed to ``abi_element_name``.
336+
argument has been changed to ``abi_element_identifier``.
337337
- JSON-RPC responses are now more strictly validated against the JSON-RPC 2.0
338338
specification while providing more informative error messages for invalid responses.
339339

docs/web3.contract.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -323,10 +323,10 @@ Each Contract Factory exposes the following methods.
323323
filter_builder.from_block = "latest"
324324
filter_builder.from_block = 0 # raises a ValueError
325325
326-
.. py:classmethod:: Contract.encode_abi(fn_name, args=None, kwargs=None, data=None)
326+
.. py:classmethod:: Contract.encode_abi(abi_element_identifier, args=None, kwargs=None, data=None)
327327
328328
Encodes the arguments using the Ethereum ABI for the contract function that
329-
matches the given ``fn_name`` and arguments ``args``. The ``data`` parameter
329+
matches the given ``abi_element_identifier`` and arguments ``args``. The ``data`` parameter
330330
defaults to the function selector.
331331

332332
.. code-block:: python

newsfragments/3473.docs.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Update ``contract.encode_abi`` signature in docs and migration guide

0 commit comments

Comments
 (0)