Skip to content

Remove redundant code comments - #16

Merged
moodysalem merged 1 commit into
mainfrom
chore/remove-redundant-comments
Oct 15, 2026
Merged

moodysalem merged 1 commit into
mainfrom
chore/remove-redundant-comments

Conversation

@moodysalem

Copy link
Copy Markdown
Member

Removes narrative code comments that restate the code from the build, check and benchmark scripts and the font stylesheet. Documentation pages, contract sources and contract examples are not touched.

What changed

  • 43 comments removed from scripts, and the header comment from src/styles/fonts.css.
  • Kept:
    • the @ts-check directive;
    • the comments in the benchmark scripts that record where each event signature and L2 fee formula came from, and how calldata is laid out. Those are the provenance of figures published on the gas page.
    • The comments in PolicyEditor.astro stay too, because they explain the schema $ref expansion and a type cast.

Equivalence

  • Comments were found with the TypeScript parser. Every changed script emits the same tokens before and after.
  • The stylesheet parses to the same PostCSS rules.

Checks

All passing: bun run format:check, bun run lint, bun run check, bun run build. The OpenAPI files that the build re-syncs from the live API were left out of this change.

Drop narrative comments that restate the code from the build, check and
benchmark scripts and the font stylesheet. Documentation pages, contract
sources and contract examples are not touched. Comments in the
benchmark scripts that record where each event signature and fee
formula came from, and how calldata is laid out, are kept because they
are the provenance of published figures.

The emitted JavaScript of every changed script is token-for-token
identical and the stylesheet parses to the same rules.
@moodysalem
moodysalem merged commit 7bfaae4 into main Oct 15, 2026
2 checks passed
@moodysalem
moodysalem deleted the chore/remove-redundant-comments branch October 15, 2026 17:57
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