Skip to content

Commit

Permalink
chore(tests/docs): fix unrendered admonitions in python docstrings (#400
Browse files Browse the repository at this point in the history
)
  • Loading branch information
danceratopz authored Jan 25, 2024
1 parent 7feae5b commit 69e1d92
Show file tree
Hide file tree
Showing 34 changed files with 0 additions and 51 deletions.
1 change: 0 additions & 1 deletion tests/berlin/eip2930_access_list/__init__.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
"""
abstract: Tests [EIP-2930: Optional access lists](https://eips.ethereum.org/EIPS/eip-2930)
Test cases for [EIP-2930: Optional access lists](https://eips.ethereum.org/EIPS/eip-2930).
"""
1 change: 0 additions & 1 deletion tests/byzantium/eip198_modexp_precompile/test_modexp.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
"""
abstract: Test [EIP-198: MODEXP Precompile](https://eips.ethereum.org/EIPS/eip-198)
Tests the MODEXP precompile, located at address 0x0000..0005. Test cases from the EIP are
labelled with `EIP-198-caseX` in the test id.
"""
Expand Down
1 change: 0 additions & 1 deletion tests/cancun/eip1153_tstore/test_tstorage.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
"""
abstract: Tests [EIP-1153: Transient Storage Opcodes](https://eips.ethereum.org/EIPS/eip-1153)
Test [EIP-1153: Transient Storage Opcodes](https://eips.ethereum.org/EIPS/eip-1153). Ports
and extends some tests from
[ethereum/tests/src/EIPTestsFiller/StateTests/stEIP1153-transientStorage/](https://github.com/ethereum/tests/blob/9b00b68593f5869eb51a6659e1cc983e875e616b/src/EIPTestsFiller/StateTests/stEIP1153-transientStorage)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
"""
abstract: Tests for [EIP-1153: Transient Storage](https://eips.ethereum.org/EIPS/eip-1153)
Test cases for `TSTORE` and `TLOAD` opcode calls in contract initcode.
""" # noqa: E501

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
"""
abstract: Tests for [EIP-1153: Transient Storage](https://eips.ethereum.org/EIPS/eip-1153)
Test cases for `TSTORE` and `TLOAD` opcode calls in different execution contexts.
""" # noqa: E501

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
"""
abstract: Tests for [EIP-1153: Transient Storage](https://eips.ethereum.org/EIPS/eip-1153)
Test cases for `TSTORE` and `TLOAD` opcode calls in reentrancy contexts.
""" # noqa: E501

Expand Down
1 change: 0 additions & 1 deletion tests/cancun/eip1153_tstore/test_tstorage_selfdestruct.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
"""
abstract: Tests for [EIP-1153: Transient Storage](https://eips.ethereum.org/EIPS/eip-1153)
Test cases for `TSTORE` and `TLOAD` opcode calls in reentrancy after self-destruct, taking into
account the changes in EIP-6780.
""" # noqa: E501
Expand Down
6 changes: 0 additions & 6 deletions tests/cancun/eip4788_beacon_root/test_beacon_root_contract.py
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
"""
abstract: Tests beacon block root for [EIP-4788: Beacon block root in the EVM](https://eips.ethereum.org/EIPS/eip-4788)
Test the exposed beacon chain root in the EVM for [EIP-4788: Beacon block root in the EVM](https://eips.ethereum.org/EIPS/eip-4788)
note: Adding a new test
Add a function that is named `test_<test_name>` and takes at least the following arguments:
- state_test
Expand All @@ -14,10 +12,6 @@
- post
- valid_call
The following arguments *need* to be parametrized or the test will not be generated:
-
All other `pytest.fixtures` can be parametrized to generate new combinations and test
cases.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
"""
abstract: Tests beacon block root for [EIP-4788: Beacon block root in the EVM](https://eips.ethereum.org/EIPS/eip-4788)
Test the exposed beacon chain root in the EVM for [EIP-4788: Beacon block root in the EVM](https://eips.ethereum.org/EIPS/eip-4788) using multi-block tests
note: Adding a new test
Add a function that is named `test_<test_name>` and takes at least the following arguments:
- blockchain_test
Expand All @@ -14,10 +12,6 @@
- post
- valid_call
The following arguments *need* to be parametrized or the test will not be generated:
-
All other `pytest.fixtures` can be parametrized to generate new combinations and test
cases.
Expand Down
2 changes: 0 additions & 2 deletions tests/cancun/eip4844_blobs/test_blob_txs.py
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
"""
abstract: Tests blob type transactions for [EIP-4844: Shard Blob Transactions](https://eips.ethereum.org/EIPS/eip-4844)
Test blob type transactions for [EIP-4844: Shard Blob Transactions](https://eips.ethereum.org/EIPS/eip-4844).
note: Adding a new test
Add a function that is named `test_<test_name>` and takes at least the following arguments:
- blockchain_test or state_test
Expand Down
1 change: 0 additions & 1 deletion tests/cancun/eip4844_blobs/test_blob_txs_full.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
"""
abstract: Tests full blob type transactions for [EIP-4844: Shard Blob Transactions](https://eips.ethereum.org/EIPS/eip-4844)
Test full blob type transactions for [EIP-4844: Shard Blob Transactions](https://eips.ethereum.org/EIPS/eip-4844).
""" # noqa: E501
Expand Down
2 changes: 0 additions & 2 deletions tests/cancun/eip4844_blobs/test_blobhash_opcode.py
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
"""
abstract: Tests `BLOBHASH` opcode in [EIP-4844: Shard Blob Transactions](https://eips.ethereum.org/EIPS/eip-4844)
Test cases for the `BLOBHASH` opcode in
[EIP-4844: Shard Blob Transactions](https://eips.ethereum.org/EIPS/eip-4844).
note: Adding a new test
Add a function that is named `test_<test_name>` and takes at least the following arguments:
- blockchain_test
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
"""
abstract: Tests `BLOBHASH` opcode in [EIP-4844: Shard Blob Transactions](https://eips.ethereum.org/EIPS/eip-4844)
Test case for `BLOBHASH` opcode calls across different contexts
in [EIP-4844: Shard Blob Transactions](https://eips.ethereum.org/EIPS/eip-4844).
Expand Down
2 changes: 0 additions & 2 deletions tests/cancun/eip4844_blobs/test_excess_blob_gas.py
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
"""
abstract: Tests `excessBlobGas` and `blobGasUsed` block fields for [EIP-4844: Shard Blob Transactions](https://eips.ethereum.org/EIPS/eip-4844)
Test `excessBlobGas` and `blobGasUsed` block fields for [EIP-4844: Shard Blob Transactions](https://eips.ethereum.org/EIPS/eip-4844).
note: Adding a new test
Add a function that is named `test_<test_name>` and takes at least the following arguments:
- blockchain_test
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
"""
abstract: Tests `excessBlobGas` and `blobGasUsed` block fields for [EIP-4844: Shard Blob Transactions](https://eips.ethereum.org/EIPS/eip-4844) at fork transition.
Test `excessBlobGas` and `blobGasUsed` block fields for [EIP-4844: Shard Blob Transactions](https://eips.ethereum.org/EIPS/eip-4844) at fork
transition.
""" # noqa: E501
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
"""
abstract: Tests point evaluation precompile for [EIP-4844: Shard Blob Transactions](https://eips.ethereum.org/EIPS/eip-4844)
Test point evaluation precompile for [EIP-4844: Shard Blob Transactions](https://eips.ethereum.org/EIPS/eip-4844).
note: Adding a new test
Add a function that is named `test_<test_name>` and takes at least the following arguments:
- blockchain_test | state_test
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
"""
abstract: Tests gas usage on point evaluation precompile for [EIP-4844: Shard Blob Transactions](https://eips.ethereum.org/EIPS/eip-4844)
Test gas usage on point evaluation precompile for [EIP-4844: Shard Blob Transactions](https://eips.ethereum.org/EIPS/eip-4844).
""" # noqa: E501
Expand Down
1 change: 0 additions & 1 deletion tests/cancun/eip5656_mcopy/test_mcopy.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
"""
abstract: Tests [EIP-5656: MCOPY - Memory copying instruction](https://eips.ethereum.org/EIPS/eip-5656)
Test copy operations of [EIP-5656: MCOPY - Memory copying instruction](https://eips.ethereum.org/EIPS/eip-5656)
""" # noqa: E501
Expand Down
1 change: 0 additions & 1 deletion tests/cancun/eip5656_mcopy/test_mcopy_contexts.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
"""
abstract: Tests [EIP-5656: MCOPY - Memory copying instruction](https://eips.ethereum.org/EIPS/eip-5656)
Test memory copy under different call contexts [EIP-5656: MCOPY - Memory copying instruction](https://eips.ethereum.org/EIPS/eip-5656)
""" # noqa: E501
Expand Down
1 change: 0 additions & 1 deletion tests/cancun/eip5656_mcopy/test_mcopy_memory_expansion.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
"""
abstract: Tests [EIP-5656: MCOPY - Memory copying instruction](https://eips.ethereum.org/EIPS/eip-5656)
Test copy operations of [EIP-5656: MCOPY - Memory copying instruction](https://eips.ethereum.org/EIPS/eip-5656)
that produce a memory expansion, and potentially an out-of-gas error.
Expand Down
1 change: 0 additions & 1 deletion tests/cancun/eip6780_selfdestruct/test_selfdestruct.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
"""
abstract: Tests [EIP-6780: SELFDESTRUCT only in same transaction](https://eips.ethereum.org/EIPS/eip-6780)
Tests for [EIP-6780: SELFDESTRUCT only in same transaction](https://eips.ethereum.org/EIPS/eip-6780).
""" # noqa: E501
Expand Down
1 change: 0 additions & 1 deletion tests/cancun/eip7516_blobgasfee/test_blobgasfee_opcode.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
"""
abstract: Tests [EIP-7516: BLOBBASEFEE opcode](https://eips.ethereum.org/EIPS/eip-7516)
Test BLOBGASFEE opcode [EIP-7516: BLOBBASEFEE opcode](https://eips.ethereum.org/EIPS/eip-7516)
""" # noqa: E501
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
"""
abstract: Tests the nested CALL/CALLCODE opcode gas consumption with a positive value transfer.
This test is designed to investigate an issue identified in EthereumJS, as reported in:
https://github.com/ethereumjs/ethereumjs-monorepo/issues/3194.
Expand Down
1 change: 0 additions & 1 deletion tests/frontier/opcodes/test_dup.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
"""
abstract: Test DUP
Test the DUP opcodes.
"""
Expand Down
1 change: 0 additions & 1 deletion tests/istanbul/eip1344_chainid/__init__.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
"""
abstract: Tests [EIP-1344: ChainID Opcode](https://eips.ethereum.org/EIPS/eip-1344)
Test cases for [EIP-1344: ChainID Opcode](https://eips.ethereum.org/EIPS/eip-1344).
"""
1 change: 0 additions & 1 deletion tests/istanbul/eip1344_chainid/test_chainid.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
"""
abstract: Tests [EIP-1344: CHAINID opcode](https://eips.ethereum.org/EIPS/eip-1344)
Test cases for [EIP-1344: CHAINID opcode](https://eips.ethereum.org/EIPS/eip-1344).
"""

Expand Down
1 change: 0 additions & 1 deletion tests/shanghai/eip3651_warm_coinbase/__init__.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
"""
abstract: Tests [EIP-3651: Warm COINBASE](https://eips.ethereum.org/EIPS/eip-3651)
Tests for [EIP-3651: Warm COINBASE](https://eips.ethereum.org/EIPS/eip-3651).
"""
2 changes: 0 additions & 2 deletions tests/shanghai/eip3651_warm_coinbase/test_warm_coinbase.py
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
"""
abstract: Tests [EIP-3651: Warm COINBASE](https://eips.ethereum.org/EIPS/eip-3651)
Tests for [EIP-3651: Warm COINBASE](https://eips.ethereum.org/EIPS/eip-3651).
note: Tests ported from:
- [ethereum/tests/pull/1082](https://github.com/ethereum/tests/pull/1082).
"""

Expand Down
1 change: 0 additions & 1 deletion tests/shanghai/eip3855_push0/__init__.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
"""
abstract: Tests [EIP-3855: PUSH0 Instruction](https://eips.ethereum.org/EIPS/eip-3855)
Tests for [EIP-3855: PUSH0 Instruction](https://eips.ethereum.org/EIPS/eip-3855).
"""
2 changes: 0 additions & 2 deletions tests/shanghai/eip3855_push0/test_push0.py
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
"""
abstract: Tests [EIP-3855: PUSH0 Instruction](https://eips.ethereum.org/EIPS/eip-3855)
Tests for [EIP-3855: PUSH0 Instruction](https://eips.ethereum.org/EIPS/eip-3855).
note: Tests ported from:
- [ethereum/tests/pull/1033](https://github.com/ethereum/tests/pull/1033).
"""

Expand Down
1 change: 0 additions & 1 deletion tests/shanghai/eip3860_initcode/__init__.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
"""
abstract: Test [EIP-3860: Limit and meter initcode](https://eips.ethereum.org/EIPS/eip-3860)
Tests for [EIP-3860: Limit and meter initcode](https://eips.ethereum.org/EIPS/eip-3860).
"""
2 changes: 0 additions & 2 deletions tests/shanghai/eip3860_initcode/test_initcode.py
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
"""
abstract: Test [EIP-3860: Limit and meter initcode](https://eips.ethereum.org/EIPS/eip-3860)
Tests for [EIP-3860: Limit and meter initcode](https://eips.ethereum.org/EIPS/eip-3860).
note: Tests ported from:
- [ethereum/tests/pull/990](https://github.com/ethereum/tests/pull/990)
- [ethereum/tests/pull/1012](https://github.com/ethereum/tests/pull/990)
"""
Expand Down
1 change: 0 additions & 1 deletion tests/shanghai/eip4895_withdrawals/__init__.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
"""
abstract: Tests [EIP-4895: Beacon chain withdrawals](https://eips.ethereum.org/EIPS/eip-4895)
Test cases for [EIP-4895: Beacon chain push withdrawals as
operations](https://eips.ethereum.org/EIPS/eip-4895).
"""
1 change: 0 additions & 1 deletion tests/shanghai/eip4895_withdrawals/test_withdrawals.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
"""
abstract: Tests [EIP-4895: Beacon chain withdrawals](https://eips.ethereum.org/EIPS/eip-4895)
Test cases for [EIP-4895: Beacon chain push withdrawals as
operations](https://eips.ethereum.org/EIPS/eip-4895).
"""
Expand Down

0 comments on commit 69e1d92

Please sign in to comment.