docs: replace static coverage percentage badge#24
Conversation
|
Thanks. The badge change itself is a reasonable take on #3's "drop the number" option. The problem is that this branch is stacked on your #23 branch, so the diff against main also carries the pyproject/uv.lock/CLAUDE.md dependency changes, despite the description saying no functional changes. Those can't land (see my comment on #23 for why; short version: inspect-robots is on PyPI now, so the git pin is a downgrade and would break our next release upload). Could you rebase onto main so this PR contains only the README badge commit? I'll take another look after that. |
worldevals and inspect-robots have both been on PyPI since 0.3.x, but the catalog home page and CLAUDE.md still told users to install from git tags (two commands, pinned to inspect-robots v0.3.0). Replace both with 'pip install worldevals' and note in CLAUDE.md why direct git references must not come back: PyPI rejects wheels with direct-URL deps, which would break the release workflow at upload. Surfaced while reviewing #23/#24; closes out the stale-docs remainder of #2. Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
74e16ca to
5cc6018
Compare
|
Thanks for the review. I've rebased the branch onto main and removed the dependency-related changes from #23. This PR now contains only the README coverage badge update. |
jeqcho
left a comment
jeqcho
left a comment
There was a problem hiding this comment.
Thanks for poking at the badges — hardcoded numbers in READMEs deserve suspicion, so I get where this came from.
This one's enforced, though. CI runs the suite with fail_under = 100 (see [tool.coverage.report] in pyproject.toml), so if coverage ever slips below 100% the build goes red. The badge can't quietly rot the way a hand-typed number would. And since coverage: gated is also a static label, the swap trades a specific, enforced claim for a vaguer one. The other robocurve repos use the same 100% badge too, so worldevals would become the odd one out.
If drift is the thing you want to kill, a genuinely dynamic badge — a shields endpoint that CI updates after the coverage run — would be a real improvement and I'd happily take that PR. Passing on this version, but the one-line diff and honest description made it a quick, pleasant review. Hope to see you back.
2 participants
Summary
Replace the static
coverage 100%badge in the README with a non-numericcoverage-gatedbadge.Why
The previous badge hardcoded a coverage percentage and could become misleading if the CI coverage threshold changes in the future. The new badge accurately reflects that coverage is enforced by CI without claiming a specific percentage.
Changes
coverage-100%badge withcoverage-gated