Skip to content

Commit b56f609

Browse files
danceratopzclaude
andauthored
docs: fix grammar in consume/ and execute/ docs (#54)
- cache.md: "as following" → "as follows", "A URLs" → "A URL" - hive.md: added missing comma - remote.md: "Running Test" → "Running Tests", "first creates" → "first create" - eth_config.md: "can be ran" → "can be run" - index.md: "Further more" → "Furthermore" Co-authored-by: Claude <noreply@anthropic.com>
1 parent d1614c4 commit b56f609

6 files changed

Lines changed: 8 additions & 8 deletions

File tree

docs/running_tests/consume/cache.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ All `consume` subcommands have an `--input` argument, which implements the same
1010

1111
## Example: Two-liner to Download the Latest Fixture Release
1212

13-
Releases can be downloaded using EEST tooling without (manually) cloning and installing the @ethereum/execution-spec-tests tools as following:
13+
Releases can be downloaded using EEST tooling without (manually) cloning and installing the @ethereum/execution-spec-tests tools as follows:
1414

1515
1. Install `uv` (a fast, rust-based Python package manager):
1616

@@ -49,7 +49,7 @@ All `consume` sub-commands take an `--input=<fixture_path>|<release_spec>|<url>`
4949

5050
1. **A local directory**: Fixtures from your local file system.
5151
2. **A release specification**: An EEST release tag or "release specification" `stable@latest`, `fusaka-devnet-1@v1.0.0`, etc.
52-
3. **A URLs**: A full URL to a custom hosted release or a Github release.
52+
3. **A URL**: A full URL to a custom hosted release or a Github release.
5353

5454
### Release Specifications
5555

docs/running_tests/execute/eth_config.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ This command verifies that a client is correctly configured for a specific netwo
1818

1919
### Standalone, Direct Usage
2020

21-
The `eth-config` sub-command can be ran directly, without cloning @ethereum/execution-spec-tests, by [installing uv](https://docs.astral.sh/uv/getting-started/installation/) and running:
21+
The `eth-config` sub-command can be run directly, without cloning @ethereum/execution-spec-tests, by [installing uv](https://docs.astral.sh/uv/getting-started/installation/) and running:
2222

2323
```bash
2424
uv run --with git+https://github.com/ethereum/execution-spec-tests.git execute eth-config --network Mainnet --rpc-endpoint http://<ETH_RPC_ENDPOINT>

docs/running_tests/execute/hive.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ and running:
4242
uv run execute hive --fork=Cancun
4343
```
4444

45-
If the command above leads to errors such as `ImportError: Error importing plugin "pytest_plugins.execute.rpc.hive": No module named 'hive.client'` run the following to fix it: `uv run eest clean --all`.
45+
If the command above leads to errors such as `ImportError: Error importing plugin "pytest_plugins.execute.rpc.hive": No module named 'hive.client'`, run the following to fix it: `uv run eest clean --all`.
4646

4747
This will execute all available tests in the `tests` directory on the `Cancun` fork by connecting to the hive server running on `http://127.0.0.1:3000` and launching a single client with the appropriate genesis file.
4848

docs/running_tests/execute/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ The test execution with the `execute` plugin is different from the `fill` plugin
3131

3232
### EOA and Contract Addresses
3333

34-
The `fill` plugin will pre-allocate all the accounts and contracts that are used in the tests, so the addresses of the accounts and contracts will be known before the tests are executed, Further more, the test contracts will start from the same address on different tests, so there are collisions on the account addresses used across different tests. This is not the case with the `execute` plugin, as the accounts and contracts are deployed on the fly, from sender keys that are randomly generated and therefore are different in each execution.
34+
The `fill` plugin will pre-allocate all the accounts and contracts that are used in the tests, so the addresses of the accounts and contracts will be known before the tests are executed. Furthermore, the test contracts will start from the same address on different tests, so there are collisions on the account addresses used across different tests. This is not the case with the `execute` plugin, as the accounts and contracts are deployed on the fly, from sender keys that are randomly generated and therefore are different in each execution.
3535

3636
Reasoning behind the random generation of the sender keys is that one can execute the same test multiple times in the same network and the plugin will not fail because the accounts and contracts are already deployed.
3737

docs/running_tests/execute/remote.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Running Test on a Live Remote Network
1+
# Running Tests on a Live Remote Network
22

33
Tests can be executed on a live remote network by running the `execute remote` command.
44

@@ -193,7 +193,7 @@ See [Transaction Metadata](./transaction_metadata.md) for details.
193193

194194
## `execute` Command Test Execution
195195

196-
The `execute remote` and `execute hive` commands first creates a random sender account from which all required test accounts will be deployed and funded, and this account is funded by sweeping (by default) this "seed" account.
196+
The `execute remote` and `execute hive` commands first create a random sender account from which all required test accounts will be deployed and funded, and this account is funded by sweeping (by default) this "seed" account.
197197

198198
The sweep amount can be configured by setting the `--seed-account-sweep-amount` flag:
199199

repo_subpaths_for_grammar_check.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Status legend: `[ ]` pending, `[~]` in progress, `[x]` complete
88

99
- [x] `docs/running_tests/test_formats/common_types.md`, `blockchain_test.md`, `blockchain_test_sync.md` (~920 lines, 3 files)
1010
- [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)
11-
- [ ] `docs/running_tests/consume/**/*.md`, `docs/running_tests/execute/**/*.md` (~950 lines, 10 files)
11+
- [x] `docs/running_tests/consume/**/*.md`, `docs/running_tests/execute/**/*.md` (~950 lines, 10 files)
1212
- [ ] `docs/running_tests/hive/**/*.md`, `docs/running_tests/*.md` (~750 lines, 10 files)
1313

1414
## docs/writing_tests (~3798 lines total, split into 4 batches)

0 commit comments

Comments
 (0)