diff --git a/docs/running_tests/test_formats/blockchain_test.md b/docs/running_tests/test_formats/blockchain_test.md index bf2746538a5..78e175763a7 100644 --- a/docs/running_tests/test_formats/blockchain_test.md +++ b/docs/running_tests/test_formats/blockchain_test.md @@ -208,7 +208,7 @@ List of decoded transactions included in the block RLP. #### - `uncleHeaders`: [`List`](./common_types.md#list)`[`[`FixtureHeader`](#fixturetransaction)`]` -List of uncle headers included in the block RLP. An empty list post merge. +List of uncle headers included in the block RLP. An empty list post-merge. #### - `withdrawals`: [`Optional`](./common_types.md#optional)`[`[`List`](./common_types.md#list)`[`[`FixtureWithdrawal`](#fixturewithdrawal)`]]` `(fork: Shanghai)` @@ -280,7 +280,7 @@ Max fee per blob gas to pay (Transaction type 3) #### - `blobVersionedHashes`: [`List`](./common_types.md#list)`[`[`Hash`](./common_types.md#hash)`]` `(fork: Cancun)` -Max fee per blob gas to pay (Transaction type 3) +List of blob versioned hashes the transaction includes (Transaction type 3). #### - `v`: [`ZeroPaddedHexNumber`](./common_types.md#zeropaddedhexnumber) diff --git a/docs/running_tests/test_formats/blockchain_test_engine.md b/docs/running_tests/test_formats/blockchain_test_engine.md index 6a525a9eba3..b94752cf373 100644 --- a/docs/running_tests/test_formats/blockchain_test_engine.md +++ b/docs/running_tests/test_formats/blockchain_test_engine.md @@ -6,7 +6,7 @@ These are produced by the `StateTest` and `BlockchainTest` test specs. ## Description -The Blockchain Engine Test fixture format is used to test block validation and the consensus rules of the Ethereum blockchain, when a block is delivered through the Engine API as a `engine_newPayloadVX` directive. +The Blockchain Engine Test fixture format is used to test block validation and the consensus rules of the Ethereum blockchain, when a block is delivered through the Engine API as an `engine_newPayloadVX` directive. It does so by defining a pre-execution state, a series of blocks as `engine_newPayloadVX` directives, and a post-execution state, verifying that, after all the blocks have been processed, appended if valid or rejected if invalid, the result is the expected post-execution state. diff --git a/docs/running_tests/test_formats/blockchain_test_engine_x.md b/docs/running_tests/test_formats/blockchain_test_engine_x.md index c9dc90a4caf..60f611626b8 100644 --- a/docs/running_tests/test_formats/blockchain_test_engine_x.md +++ b/docs/running_tests/test_formats/blockchain_test_engine_x.md @@ -72,7 +72,7 @@ For each [`BlockchainTestEngineXFixture`](#blockchaintestenginexfixture) test ob - If [`postStateDiff`](#-poststatediff-optionalalloc) is present: - Apply the state differences to the pre-allocation group - Verify the resulting state matches the client's final state - - If `post` field were present (not typical), verify it directly + - If the `post` field were present (not typical), verify it directly ## Structures diff --git a/docs/running_tests/test_formats/transaction_test.md b/docs/running_tests/test_formats/transaction_test.md index 47b7a7073c1..701d3d4512e 100644 --- a/docs/running_tests/test_formats/transaction_test.md +++ b/docs/running_tests/test_formats/transaction_test.md @@ -6,7 +6,7 @@ These are produced by the `TransactionTest` test spec. ## Description -The transaction test fixture format is used to test client's transaction RLP parsing without executing the transaction on the EVM. +The transaction test fixture format is used to test a client's transaction RLP parsing without executing the transaction on the EVM. It does so by defining a transaction binary RLP representation, and whether the transaction should be accepted or rejected by the client in each fork. diff --git a/grammar_manual_verification.md b/grammar_manual_verification.md index 36070c913c9..c2ce48ee5dc 100644 --- a/grammar_manual_verification.md +++ b/grammar_manual_verification.md @@ -13,3 +13,7 @@ Format (but don't add a codeblock for each item): --- + +- [ ] docs/running_tests/test_formats/state_test.md:61 - "Mapping of lists of post for verification per fork" + Suggestion: "Mapping of lists of `FixtureForkPost` for verification per fork" or "Mapping of lists for the `post` field for verification per fork" + Reason: The word "post" without backticks is ambiguous - unclear if referring to the field name or a technical term diff --git a/repo_subpaths_for_grammar_check.md b/repo_subpaths_for_grammar_check.md index 48ace59126a..d316ead65af 100644 --- a/repo_subpaths_for_grammar_check.md +++ b/repo_subpaths_for_grammar_check.md @@ -7,7 +7,7 @@ Status legend: `[ ]` pending, `[~]` in progress, `[x]` complete ## docs/running_tests (~3274 lines total, split into 4 batches) - [x] `docs/running_tests/test_formats/common_types.md`, `blockchain_test.md`, `blockchain_test_sync.md` (~920 lines, 3 files) -- [ ] `docs/running_tests/test_formats/blockchain_test_engine.md`, `blockchain_test_engine_x.md`, `state_test.md`, `transaction_test.md`, `exceptions.md`, `index.md` (~650 lines, 6 files) +- [x] `docs/running_tests/test_formats/blockchain_test_engine.md`, `blockchain_test_engine_x.md`, `state_test.md`, `transaction_test.md`, `exceptions.md`, `index.md` (~650 lines, 6 files) - [ ] `docs/running_tests/consume/**/*.md`, `docs/running_tests/execute/**/*.md` (~950 lines, 10 files) - [ ] `docs/running_tests/hive/**/*.md`, `docs/running_tests/*.md` (~750 lines, 10 files)