docs: add per-module coverage target - #176
Conversation
Signed-off-by: WilliamK112 <164879897+WilliamK112@users.noreply.github.com>
|
Warning Review limit reached
Next review available in: 29 minutes You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (2)
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 |
|
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 #163.
Acceptance criteria
| Criterion | Status |
|---|---|
| Documented command prints per-file coverage | Pass — make coverage-report runs the fast lane with --cov-report=term-missing |
| Roadmap Testing tier references it | Pass |
mkdocs build --strict |
Pass (author + CI) |
Notes
- The target is a thin wrapper over the existing pytest
addopts(--cov-report=term-missingis already inpyproject.toml). That’s still the right contributor-facing command. - Pointing people at
semantic.consistencyandexecution/as current thin spots is reasonable; the “use the live report, don’t hard-code a %” wording is the important part.
Small, useful docs/tooling PR. Good to merge.
|
Nice one, @WilliamK112 — Pointing people at the live per-module table (instead of a hard-coded %) is the right call. Thanks for landing this. |
Summary
make coverage-reporttarget that runs the same fast test scope as PR CI and prints the per-fileterm-missingtablemake helpCloses #163.
Validation
make coverage-report PY=<project-venv>/bin/python— 4051 passed, 6 skipped, 12 deselected; 93.16% total coverage with the per-module missing-lines tablepython -m mkdocs build --strictmake -n coverage-reportmake helpgit diff --checkAI usage
I used Codex to inspect the repository's existing coverage configuration, implement the scoped Makefile/docs changes, and run the validation above. I reviewed the final diff and command output.