docs: align test and coverage claims - #177
Conversation
Signed-off-by: WilliamK112 <164879897+WilliamK112@users.noreply.github.com>
|
Important Review skippedNo new commits to review since the last review. ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughThe documentation now states that ChangesDocumentation metrics
Estimated code review effort: 1 (Trivial) | ~3 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
@coderabbitai review |
|
Strix is installed on this repository, but we couldn't run this PR security review because this workspace's trial has ended. Add a card to resume code reviews here. So far, Strix has reviewed 36 pull requests, surfaced 3 security issues (1 critical/high) and blocked 1 risky merge across this workspace. |
|
kevincostner17
left a comment
There was a problem hiding this comment.
Verdict: Valid — approve
Checked against #159.
Acceptance criteria
| Criterion | Status |
|---|---|
| Single coverage figure (93%) across docs/README | Pass after this PR |
| No contradictory test-count claims | Pass — remaining 800+ / 95%+ were only in docs/faq.md and docs/feature-overview.md |
Aligns with --cov-fail-under=93 |
Pass |
mkdocs build --strict |
Pass (author + CI) |
Verification
I grepped docs/ and README.md on main:
- Already correct:
docs/index.md(“1,200+ tests, 93% coverage gate”),README.md(93% gate), contributing docs,trust-claims.md - Stale (this PR):
docs/faq.md,docs/feature-overview.md
After the change, wording matches the enforced gate and the index. No leftover 800+ / 95%+ claims.
Good to merge.
|
Thanks @WilliamK112 — this was a small but important honesty fix. Aligning FAQ and the feature overview with the actual 93% CI gate (and dropping the stale 800+/95% figures) keeps the public claims consistent. Appreciate you catching and cleaning that up. |
Summary
800+ tests / 95%+ coverageclaims in the FAQ and feature overview1,200+ tests / 93% CI-enforced coverage gatewording used by the documentation index and repository configurationWhy
The two stale pages contradicted both the documentation index and the actual
--cov-fail-under=93test configuration, which made the project's public quality claims inconsistent.Validation
800+ testsor95%+ coverageclaims1,200+ testsand93% coverage gatewording is present across the public docsmkdocs build --strictgit diff --checkCloses #159
AI-assisted: Codex was used to help audit and update the documentation; the final diff and strict documentation build were reviewed locally.
Summary by CodeRabbit