Skip to content

chore: sweep prose and test conventions#85

Merged
hakula139 merged 5 commits into
mainfrom
chore/test-convention-sweep
May 14, 2026
Merged

chore: sweep prose and test conventions#85
hakula139 merged 5 commits into
mainfrom
chore/test-convention-sweep

Conversation

@hakula139
Copy link
Copy Markdown
Owner

@hakula139 hakula139 commented May 14, 2026

Summary

Tightens prose and test organization against the repo conventions before the drift gets harder to review. The branch keeps behavior unchanged and focuses on comments, docs, ordering, and test names.

  • Clarifies extra_ca_certs user-guide behavior while keeping the trust-setting caveats visible.
  • Tightens /compact user-facing docs around resume behavior, tracker reset, and queued prompts without describing raw JSONL mechanics.
  • Normalizes high-signal rustdoc / module-doc punctuation and trims redundant comments while keeping comments that encode constraints or regression intent.
  • Reorders tests to mirror implementation order, then applies the scenario-focused test-name sweep identified during review.

Design decisions

  • Keep durable comments. Comments that encode hidden constraints, regression intent, or API shape were preserved. The cleanup targets punctuation and redundant explanatory comments, not useful rationale.
  • Keep compact design docs intact. The /compact design doc is long, but the feature is large enough to justify an internal design record. The user guide was the right place to trim implementation detail.

Changes

File Description
docs/guide/configuration.md Tightens extra_ca_certs and auth prose while preserving path-resolution and project-config rejection details.
docs/guide/slash-commands.md Rewrites /compact docs around visible resume and tracker behavior.
docs/design/slash/compact.md Renames one design decision heading to avoid contrast-heavy wording.
CLAUDE.md Fixes awkward punctuation in the lint-suppression convention.
agent/event.rs, session/*, slash/*, tui/*, client/anthropic/* Normalizes rustdoc/module-doc punctuation on high-signal public surfaces.
client/anthropic.rs, config/oauth.rs, tui/components/chat.rs, tui/components/input.rs, tui/modal/kv_overview.rs Reorders tests so sections follow implementation order and happy paths precede variants/errors.
client/anthropic.rs, config/oauth.rs, session/*, tui/components/*, tui/theme/loader.rs Renames tests whose old names described mechanics like returns/routes/sets/appends instead of scenarios.

Test plan

  • cargo fmt --all --check
  • cargo build
  • cargo clippy --all-targets -- -D warnings: zero warnings
  • cargo test: 2025 tests pass
  • cargo llvm-cov --ignore-filename-regex 'main\.rs': 98.63% line coverage
  • pnpm lint: 0 errors
  • pnpm spellcheck: 0 issues

hakula139 added 4 commits May 13, 2026 19:02
Partial pass over the sweep identified by two reviewers against
CLAUDE.md's naming rule ("name tests by the scenario they cover,
prefixed by the function name"). Touches only name changes where the
current wording described internal operations (appends/routes/returns
none/sets field) instead of observable outcomes; every rename has a
sibling test or adjacent scenario-phrased neighbour to anchor the
style.

Safety-net commit: this branch will be rebased onto main after PR #84
lands and the remaining comment / test-ordering priorities are
addressed in follow-up commits.
@hakula139 hakula139 self-assigned this May 14, 2026
@codecov
Copy link
Copy Markdown

codecov Bot commented May 14, 2026

Codecov Report

❌ Patch coverage is 99.59016% with 1 line in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
crates/oxide-code/src/client/anthropic.rs 99.35% 1 Missing ⚠️

📢 Thoughts on this report? Let us know!

@hakula139 hakula139 added refactor Reorganize the code to be cleaner and easier readable documentation Improvements or additions to documentation and removed refactor Reorganize the code to be cleaner and easier readable labels May 14, 2026
@hakula139 hakula139 merged commit 9f9dec6 into main May 14, 2026
4 checks passed
@hakula139 hakula139 deleted the chore/test-convention-sweep branch May 14, 2026 03:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant