Skip to content

Commit aa47e69

Browse files
committed
Link to newly-created docs in release notes
1 parent f7f3cbf commit aa47e69

File tree

1 file changed

+15
-11
lines changed

1 file changed

+15
-11
lines changed

docs/release_notes.rst

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@ Features
1111

1212
- Add new Chain APIs (`#1887 <https://github.com/ethereum/py-evm/issues/1887>`__):
1313

14-
- `get_canonical_block_header_by_number`
15-
- `get_canonical_transaction_index`
16-
- `get_canonical_transaction_by_index`
17-
- `get_transaction_receipt_by_index`
14+
- :meth:`~eth.chains.base.Chain.get_canonical_block_header_by_number` (parallel to :meth:`~eth.chains.base.Chain.get_canonical_block_by_number`)
15+
- :meth:`~eth.chains.base.Chain.get_canonical_transaction_index`
16+
- :meth:`~eth.chains.base.Chain.get_canonical_transaction_by_index`
17+
- :meth:`~eth.chains.base.Chain.get_transaction_receipt_by_index`
1818

1919

2020
Bugfixes
@@ -32,13 +32,17 @@ Improved Documentation
3232
- Tweak layout of API docs to improve readability
3333

3434
Group API docs by member (methods, attributes) (`#1797 <https://github.com/ethereum/py-evm/issues/1797>`__)
35-
- Add missing API docs for ``MiningChain``.
36-
Add missing API docs for ``eth.db.*``
37-
Add missing API docs for ``Constantinople``, ``Petersburg`` and ``Istanbul`` forks
38-
Move all docstrings that aren't overly specific to a particular implementation from
39-
the implementation to the interface. This has the effect that the docstring will
40-
appear both on the interface as well as on the implementation except for when the
41-
implementation overwrites the docstring with a more specific descriptions. (`#1880 <https://github.com/ethereum/py-evm/issues/1880>`__)
35+
- API doc additions (`#1880 <https://github.com/ethereum/py-evm/issues/1880>`__)
36+
37+
- Add missing API docs for :class:`~eth.chains.base.MiningChain`.
38+
- Add missing API docs for :mod:`eth.db.*`
39+
- Add missing API docs for :class:`~eth.vm.forks.constantinople.ConstantinopleVM`,
40+
:class:`~eth.vm.forks.petersburg.PetersburgVM` and
41+
:class:`~eth.vm.forks.istanbul.IstanbulVM` forks
42+
- Move all docstrings that aren't overly specific to a particular implementation from
43+
the implementation to the interface. This has the effect that the docstring will
44+
appear both on the interface as well as on the implementation except for when the
45+
implementation overwrites the docstring with a more specific descriptions.
4246
- Add docstrings to all public APIs that were still lacking one. (`#1882 <https://github.com/ethereum/py-evm/issues/1882>`__)
4347

4448

0 commit comments

Comments
 (0)