Skip to content

Update documentation for testing Package Renaming (Follow-up to PR #1654) #1672

@danceratopz

Description

@danceratopz

I got Claude to write the required changes for ./docs after the package renaming. This can be plugged into Claude for the follow-up PR.

Documentation Updates for Package Renaming (Follow-up to PR #1654)

Context

PR #1654 renamed the testing packages from ethereum_test_* to execution_testing.*, creating a unified namespace. All source code has been updated, but documentation updates were deferred to a separate PR to keep the main PR focused and manageable.

This issue tracks all documentation changes needed to complete the renaming.

Scope

35 documentation files require updates to reflect the new package names:

ethereum_test_base_types    → execution_testing.base_types
ethereum_test_exceptions    → execution_testing.exceptions
ethereum_test_fixtures      → execution_testing.fixtures
ethereum_test_forks         → execution_testing.forks
ethereum_test_specs         → execution_testing.specs
ethereum_test_tools         → execution_testing.tools
ethereum_test_types         → execution_testing.test_types
ethereum_test_vm            → execution_testing.vm
ethereum_clis               → execution_testing.client_clis
ethereum_test_checklists    → execution_testing.checklists

Files Requiring Updates

1. Library Reference Documentation (9 files + 1 index)

Files to rename:

  • docs/library/ethereum_test_base_types.mdexecution_testing_base_types.md
  • docs/library/ethereum_test_exceptions.mdexecution_testing_exceptions.md
  • docs/library/ethereum_test_fixtures.mdexecution_testing_fixtures.md
  • docs/library/ethereum_test_forks.mdexecution_testing_forks.md
  • docs/library/ethereum_test_specs.mdexecution_testing_specs.md
  • docs/library/ethereum_test_tools.mdexecution_testing_tools.md
  • docs/library/ethereum_test_types.mdexecution_testing_test_types.md
  • docs/library/ethereum_test_vm.mdexecution_testing_vm.md
  • docs/library/ethereum_clis.mdexecution_testing_client_clis.md

mkdocstrings directives to update (10 instances):

  • docs/library/ethereum_test_base_types.md:3: ::: ethereum_test_base_types::: execution_testing.base_types
  • docs/library/ethereum_test_exceptions.md:3: ::: ethereum_test_exceptions::: execution_testing.exceptions
  • docs/library/ethereum_test_fixtures.md:3: ::: ethereum_test_fixtures::: execution_testing.fixtures
  • docs/library/ethereum_test_forks.md:3: ::: ethereum_test_forks::: execution_testing.forks
  • docs/library/ethereum_test_specs.md:3: ::: ethereum_test_specs::: execution_testing.specs
  • docs/library/ethereum_test_tools.md:3: ::: ethereum_test_tools::: execution_testing.tools
  • docs/library/ethereum_test_types.md:3: ::: ethereum_test_types::: execution_testing.test_types
  • docs/library/ethereum_test_vm.md:3: ::: ethereum_test_vm::: execution_testing.vm
  • docs/library/ethereum_clis.md:3: ::: ethereum_clis::: execution_testing.client_clis
  • docs/writing_tests/writing_a_new_test.md:330: :::: ethereum_test_tools.utility.pytest.extend_with_defaults:::: execution_testing.tools.utility.pytest.extend_with_defaults

Content in docs/library/index.md:

  • Update all bullet points listing the old module names
  • Update all links to point to renamed files

2. Writing Tests Documentation (15 files)

Import statements in code blocks (28 instances across 5 files):

  • docs/dev/interactive_usage.md (1 instance)
  • docs/writing_tests/tutorials/state_transition.md (2 instances)
  • docs/writing_tests/eip_checklist.md (3 instances)
  • docs/writing_tests/test_markers.md (19 instances)
  • docs/writing_tests/writing_a_new_test.md (3 instances)

Markdown reference links (pattern: [ClassName][ethereum_test_*]):

  • docs/writing_tests/tutorials/state_transition.md:
    • [ethereum_test_types.Environment][execution_testing.test_types.Environment]
    • [ethereum_test_types.Transaction][execution_testing.test_types.Transaction]
  • docs/writing_tests/writing_a_new_test.md:
    • [ethereum_test_vm.Opcodes][execution_testing.vm.Opcodes]
    • [ethereum_test_tools.tools_code.generators.Switch][execution_testing.tools.tools_code.generators.Switch]
    • [ethereum_test_tools.tools_code.generators.Case][execution_testing.tools.tools_code.generators.Case]
    • [ethereum_test_tools.tools_code.generators.While][execution_testing.tools.tools_code.generators.While]
    • [ethereum_test_tools.tools_code.generators.Conditional][execution_testing.tools.tools_code.generators.Conditional]
  • docs/writing_tests/exception_tests.md:
    • References to ethereum_test_exceptions library
  • Similar updates needed across all writing_tests docs

File path references in docs/writing_tests/checklist_templates/eip_testing_checklist_template.md (12 instances):

  • Line 311: src/ethereum_test_vm/opcode.pysrc/execution_testing/vm/opcode.py
  • Line 312: src/ethereum_test_forks/forks/forks.pysrc/execution_testing/forks/forks/forks.py
  • Line 507: src/ethereum_test_forks/forks/forks.pysrc/execution_testing/forks/forks/forks.py
  • Line 536: src/ethereum_test_forks/forks/forks.pysrc/execution_testing/forks/forks/forks.py
  • Line 756: src/ethereum_test_forks/forks/forks.pysrc/execution_testing/forks/forks/forks.py
  • Line 757: src/ethereum_test_forks/forks/forks.pysrc/execution_testing/forks/forks/forks.py
  • Line 1007: src/ethereum_test_forks/forks/forks.pysrc/execution_testing/forks/forks/forks.py
  • Line 1008: src/ethereum_test_forks/forks/forks.pysrc/execution_testing/forks/forks/forks.py
  • Line 1106: src/ethereum_test_forks/forks/forks.pysrc/execution_testing/forks/forks/forks.py
  • Line 1107: src/ethereum_test_forks/forks/forks.pysrc/execution_testing/forks/forks/forks.py
  • Line 1108: src/ethereum_test_forks/forks/forks.pysrc/execution_testing/forks/forks/forks.py
  • Line 1109: src/ethereum_test_forks/forks/forks.pysrc/execution_testing/forks/forks/forks.py
  • Line 1165: src/ethereum_test_forks/forks/forks.pysrc/execution_testing/forks/forks/forks.py
  • Line 1179: src/ethereum_test_forks/forks/forks.pysrc/execution_testing/forks/forks/forks.py
  • Line 127: src/ethereum_test_checklists/eip_checklist.pysrc/execution_testing/checklists/eip_checklist.py

GitHub links to source code:

  • docs/writing_tests/writing_a_new_test.md:238: Link to src/ethereum_test_types/account_types.pysrc/execution_testing/test_types/account_types.py
  • docs/writing_tests/tutorials/state_transition.md: Links to src/ethereum_test_types/block_types.py and transaction_types.py

3. Test Format Documentation (6 files)

Files in docs/running_tests/test_formats/:

  • blockchain_test.md
  • blockchain_test_engine.md
  • blockchain_test_sync.md
  • exceptions.md
  • state_test.md
  • transaction_test.md

All contain references to old module names in their content.

4. Other Documentation Files (4+ files)

  • docs/navigation.md - May contain references
  • docs/getting_started/repository_overview.md - References to src/ethereum_test_* paths
  • docs/running_tests/consume/exceptions.md - Module references
  • docs/dev/interactive_usage.md - Import statements

Changes NOT Required

Historical References (Keep As-Is)

docs/CHANGELOG.md:

  • Contains historical references to old module names in release notes
  • Recommendation: Keep unchanged as it represents historical record
  • Example: Line 259 references src/ethereum_test_types/types.py from a past change

Search Patterns for Finding Issues

# Find mkdocstrings directives
rg '^:::\s+(ethereum_test_|ethereum_clis)' docs/

# Find markdown reference links
rg '\[.*\]\[ethereum_test_' docs/

# Find import statements
rg 'from ethereum_test_|import ethereum_test_|from ethereum_clis' docs/

# Find file path references
rg 'src/ethereum_test_' docs/

# Find inline module references (excluding CHANGELOG)
rg 'ethereum_test_|ethereum_clis' docs/ --type md | grep -v CHANGELOG

Metadata

Metadata

Labels

A-docArea: documentationC-choreCategory: choreE-easyExperience: easy, good for newcomers

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions