Skip to content

chore: reformat docstrings to line-length of 79 for w505 for the weld #2134

@marioevz

Description

@marioevz

After the weld, we will need to align both repositories code-style rules, and one of them is code line-length.

EEST currently uses a line length of 100 while EELS uses 79.

EEST will change its line length to match EELS, but the full conversion will be done over at the execution-specs repository.

In the meantime we can reformat docstrings to have a maximum line length of 79.

We can do this using docformatter, which out of the box does not exactly do what we need, but a small change to its code base results it in correctly formatting the docstrings in the way we need it.

To run it we can do:

uv run --with git+https://github.com/marioevz/docformatter.git@master docformatter --wrap-summaries 79 --wrap-descriptions 79 --make-summary-multi-line -i src/ethereum_test_types/block_types.py

And replace src/ethereum_test_types/block_types.py with the file to reformat.

Folders to reformat docstrings:

  • ./tests
    • ./tests/static
    • ./tests/berlin
    • ./tests/shanghai
    • ./tests/unscheduled
    • ./tests/benchmark
    • ./tests/constantinople
    • ./tests/amsterdam
    • ./tests/frontier
    • ./tests/homestead
    • ./tests/paris
    • ./tests/cancun
    • ./tests/osaka
    • ./tests/prague
    • ./tests/istanbul
    • ./tests/byzantium
  • ./src
    • ./src/ethereum_test_vm
    • ./src/ethereum_test_specs
    • ./src/pytest_plugins
    • ./src/ethereum_test_types
    • ./src/ethereum_test_fixtures
    • ./src/ethereum_test_execution
    • ./src/ethereum_test_rpc
    • ./src/ethereum_test_exceptions
    • ./src/ethereum_test_forks
    • ./src/ethereum_test_checklists
    • ./src/ethereum_test_base_types
    • ./src/ethereum_test_tools
    • ./src/cli
    • ./src/ethereum_execution_spec_tests.egg-info
    • ./src/config
    • ./src/ethereum_clis
  • ./.github
    • ./.github/workflows
    • ./.github/configs
    • ./.github/actions
    • ./.github/scripts

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type
No fields configured for issues without a type.

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions