Skip to content

Commit ee8c217

Browse files
authored
Fix bullet point formatting in release notes (#3454)
* Fix bulletpoints in release notes * Add newsfragment
1 parent 7841a02 commit ee8c217

File tree

2 files changed

+7
-2
lines changed

2 files changed

+7
-2
lines changed

docs/release_notes.rst

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,14 @@ web3.py v7.0.0-beta.9 (2024-08-01)
1212
Breaking Changes
1313
~~~~~~~~~~~~~~~~
1414

15-
- Upgrades to use latest ``ABI`` utilities and typings from ``eth-utils`` and ``eth-typing``.
15+
* Upgrades to use latest ``ABI`` utilities and typings from ``eth-utils`` and ``eth-typing``.
16+
1617
* Typings for ``ABI`` components are now available in the ``eth-typing`` package. ``ABI`` types previously in ``web3.types`` have been removed.
1718
* New versions of existing ABI functions were added to ``eth-utils`` and are now exposed in `web3.py` via ``web3.utils.abi``.
1819
* ABI exceptions have been renamed in ``web3.exceptions``. The ``ABIEventFunctionNotFound`` and ``FallbackNotFound`` exceptions have been removed. Use ``ABIEventNotFound`` and ``ABIFallbackNotFound`` instead.
1920
* ``MismatchedABI`` exceptions are raised instead of a ``Web3ValidationError`` for ABI related errors.
2021
* ``encode_abi`` arguments have been updated to use ``abi_element_name`` instead of ``fn_name``. (`#3408 <https://github.com/ethereum/web3.py/issues/3408>`__)
22+
2123
- Remove ``Web3ValidationError`` dependence / inheritance from `eth-utils` ``ValidationError``. (`#3443 <https://github.com/ethereum/web3.py/issues/3443>`__)
2224

2325

@@ -30,13 +32,15 @@ Improved Documentation
3032
Features
3133
~~~~~~~~
3234

33-
- Utilities to extract function and event ``ABI`` attributes from a contract. Utilities in the ``web3.utils.abi`` module parse ABI elements and check encodability of provided arguments. ABI functions in ``eth-utils`` are exposed by the ``web3.utils.abi`` module.
35+
* Utilities to extract function and event ``ABI`` attributes from a contract. Utilities in the ``web3.utils.abi`` module parse ABI elements and check encodability of provided arguments. ABI functions in ``eth-utils`` are exposed by the ``web3.utils.abi`` module.
36+
3437
* ``get_abi_element_info`` returns an ``ABIElementInfo`` TypedDict with the ``abi``, ``selector``, and ``arguments``.
3538
* ``get_abi_element`` returns the ``ABI`` of a function, event, or error given the name and arguments.
3639
* ``check_if_arguments_can_be_encoded`` returns true if the arguments can be encoded with the given ABI.
3740
* ``get_event_abi`` returns the ``ABI`` of an event given the name.
3841
* ``get_event_log_topics`` returns the log topics of an event given the name.
3942
* ``log_topics_to_bytes`` returns the log topics as bytes. (`#3408 <https://github.com/ethereum/web3.py/issues/3408>`__)
43+
4044
- Add explicit stream kwarg to HTTPProvider so that timeout can be more finely tuned. (`#3428 <https://github.com/ethereum/web3.py/issues/3428>`__)
4145
- Implement a ``RequestTimedOut`` exception, extending from ``Web3RPCError``, for when requests to the node time out. (`#3440 <https://github.com/ethereum/web3.py/issues/3440>`__)
4246

newsfragments/3454.internal.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Fix Release Notes formatting

0 commit comments

Comments
 (0)