Skip to content

Commit

Permalink
chore: remove repetitive words (#493)
Browse files Browse the repository at this point in the history
* chore: remove repetitive words

Signed-off-by: redistay <[email protected]>

* chore: fix repetitive words change.

---------

Signed-off-by: redistay <[email protected]>
Co-authored-by: spencer-tb <[email protected]>
  • Loading branch information
redistay and spencer-tb authored Apr 2, 2024
1 parent e738983 commit fc36d65
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 12 deletions.
22 changes: 11 additions & 11 deletions docs/writing_tests/code_standards.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,17 @@

The Python code in the tests subdirectory `./tests` must fulfill the following checks:

| | Command | Explanation |
|---|-------------------------|---------------------------------------------------------------------------|
| 1 | `fname8 tests` | Spell check passes using the `./whitelist.txt` dictionary file. |
| 2 | `isort tests --check --diff` | Python imports ordered and arranged according to isort's standards. |
| 3 | `black tests --check --diff` | Python source must be black-formatted. |
| 4 | `flake8 tests` | Python lint and spell-checked. |
| 5 | `mypy tests` | Objects that provide typehints pass type-checking via mypy. |
| 6 | `fill` | All tests tests must execute correctly. |
| 7 | `mkdocs build --strict` | Documentation generated without warnings. |
| 8 | `pyspelling` | Markdown spell-check. |
| 9 | `markdownlint-cli2` | Markdown lint check. |
| | Command | Explanation |
|---|-------------------------|--------------------------------------------------------------------------|
| 1 | `fname8 tests` | Spell check passes using the `./whitelist.txt` dictionary file. |
| 2 | `isort tests --check --diff` | Python imports ordered and arranged according to isort's standards. |
| 3 | `black tests --check --diff` | Python source must be black-formatted. |
| 4 | `flake8 tests` | Python lint and spell-checked. |
| 5 | `mypy tests` | Objects that provide typehints pass type-checking via mypy. |
| 6 | `fill` | All tests must execute correctly. |
| 7 | `mkdocs build --strict` | Documentation generated without warnings. |
| 8 | `pyspelling` | Markdown spell-check. |
| 9 | `markdownlint-cli2` | Markdown lint check. |

While this seems like a long list, a correctly configured editor (see [VS Code Setup](../getting_started/setup_vs_code.md)) essentially assures:

Expand Down
2 changes: 1 addition & 1 deletion docs/writing_tests/exception_tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ To test for an exception, the test can use either of the following types from `e

2. [`BlockException`](../consuming_tests/exceptions.md#blockexception): To be added to the `exception` field of the `Block` object; this exception type is used when a block is expected to be invalid, but the exception is related to a block property, e.g. an invalid value of the block header.

For an example, see [`eip4844_blobs.test_excess_blob_gas.test_invalid_static_excess_blob_gas`](../tests/cancun/eip4844_blobs/test_excess_blob_gas/index.md#tests.cancun.eip4844_blobs.test_excess_blob_gas.test_invalid_static_excess_blob_gas) which raises `BlockException.INCORRECT_EXCESS_BLOB_GAS` in the case that the the `excessBlobGas` remains unchanged
For an example, see [`eip4844_blobs.test_excess_blob_gas.test_invalid_static_excess_blob_gas`](../tests/cancun/eip4844_blobs/test_excess_blob_gas/index.md#tests.cancun.eip4844_blobs.test_excess_blob_gas.test_invalid_static_excess_blob_gas) which raises `BlockException.INCORRECT_EXCESS_BLOB_GAS` in the case that the `excessBlobGas` remains unchanged
but the parent blobs included are not `TARGET_BLOBS_PER_BLOCK`.

Although exceptions can be combined with the `|` operator to indicate that a test vector can throw either one of multiple exceptions, ideally the tester should aim to use only one exception per test vector, and only use multiple exceptions on the rare instance when it is not possible to know which exception will be thrown because it depends on client implementation.
Expand Down

0 comments on commit fc36d65

Please sign in to comment.