Skip to content

tests, docs: clean up comments and prose - #239

Merged
zimbatm merged 3 commits into
mainfrom
cleanup/tests-docs
Oct 24, 2026
Merged

zimbatm merged 3 commits into
mainfrom
cleanup/tests-docs

Conversation

@zimbatm

@zimbatm zimbatm commented Oct 23, 2026

Copy link
Copy Markdown
Member

Cleanup of the Rust test code in tests/, docs/, README.md and the bench/ scripts. The test data in tests/lang, tests/corpus and tests/fixtures is unchanged.

  • Comments: test comments that repeated the test name or told change history are removed. One comment in tests/nar_parity.rs was wrong about its third case, so it is gone, not fixed.
  • Prose: README and docs in plain words, with idioms removed ("kitchen sink", "all-or-nothing").
  • A second review restored "For now" in the README Scope section, because the client-only scope is temporary.

No test was removed. fmt, clippy, ast-grep and the full test suite pass.

Remove comments that restate the code or record change history.
Remove the step numbers from the comments in e2e_build and e2e_grpc.
The numbers had a gap and no reader needs them.

Assisted-by: Claude Code (claude-opus-5)
Change-Id: Ia154d1c409dc53db3cb4d2c5ff38ed8de7cad3ac
Rewrite the padded README prose in short, active sentences. Fix the
typos ("it's own", "is feels") and remove the idioms. Keep every
number, link and limit.

Assisted-by: Claude Code (claude-opus-5)
Change-Id: I9badc0256a8872008ed953ee7cf8681b0d66195a
README.md: restore "For now" in Scope; the client-only scope is not permanent.

Assisted-by: Claude Code (claude-opus-5)
Change-Id: I119df7891ff7fb4066438a3a9fb9c05ec85d3c36
@zimbatm
zimbatm enabled auto-merge October 23, 2026 23:55
@zimbatm
zimbatm added this pull request to the merge queue Oct 23, 2026
Merged via the queue into main with commit 443dd64 Oct 24, 2026
5 checks passed
@zimbatm
zimbatm deleted the cleanup/tests-docs branch October 24, 2026 00:04
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