Skip to content

chore(docs): trim moduledocs — drop EVM Concepts and Elixir Learning Notes#136

Open
mw2000 wants to merge 1 commit intomainfrom
chore/trim-moduledocs
Open

chore(docs): trim moduledocs — drop EVM Concepts and Elixir Learning Notes#136
mw2000 wants to merge 1 commit intomainfrom
chore/trim-moduledocs

Conversation

@mw2000
Copy link
Copy Markdown
Owner

@mw2000 mw2000 commented May 2, 2026

Summary

  • Removes the `## EVM Concepts` (yellow-paper / EIP recaps duplicating public references) and `## Elixir Learning Notes` (Elixir tutorial content) sections from every `@moduledoc` in `lib/`. Neither belongs in API documentation.
  • 43 files touched, -780 LOC net (947 deletions, 167 insertions).
  • Lead-in descriptions and API-relevant content (field tables, wire-encoding notes, examples, doctests) are preserved. Function-level `@doc`s untouched.
  • Where deletions left the lead-in too thin, a tight 1–3 sentence factual replacement was written grounded in the code (e.g. `block/withdrawal.ex`, `system_contracts/block_hashes.ex`, `world_state.ex`).

Test plan

  • `mix compile` clean
  • `mix format --check-formatted` clean
  • `mix credo --strict` — 1175 mods/funs, found no issues
  • `mix test` — 4 doctests, 617 tests, 0 failures
  • `grep -r "## EVM Concepts\|## Elixir Learning Notes" lib/` returns nothing

🤖 Generated with Claude Code

…Notes sections

The "## EVM Concepts" sections were yellow-paper / EIP recaps duplicating
public references; the "## Elixir Learning Notes" sections were Elixir
tutorial content. Neither belongs in API documentation. Lead-in
descriptions and API-relevant content (field tables, wire-encoding notes,
examples) are preserved.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant