docs: sync — correct CI test-count claims in README - #15
Merged
Conversation
… CI) Verified locally: pytest collects 26 test functions across tests/, but test_similarity_judge.py and test_trained_classifier_judge.py each importorskip an optional dependency (sentence-transformers, scikit-learn) that CI's install step (pydantic pytest pyyaml only) never installs — 8 tests always skip there. README's four "26 tests"/"26/26" claims overstated what CI actually runs; corrected to 18/26 in CI, 26/26 with the optional extras installed.
serpeigd
marked this pull request as ready for review
August 17, 2026 22:07
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Scheduled documentation-sync pass. Reviewed README.md and docs/DESIGN.md against the actual working tree (
src/preshow/,evals/,webapp/,tests/,content/) — both were already accurate and current (Milestone 1 complete, six-judge search closed, D1–D16 consistent, all 20 titles havetmdb_id, 8/20 researched entries present, all documented API routes exist). No stale claims found there.One real inaccuracy found and fixed: README claimed "26 tests" / "26/26 passing" in four places. Verified by actually running
pytest tests/ -qin this environment with only the deps CI installs (pydantic pytest pyyaml) — result is 18 passed, 2 skipped (8 test functions never run).test_similarity_judge.py/test_trained_classifier_judge.pyeachpytest.importorskipan optional dependency (sentence-transformers,scikit-learn) that.github/workflows/tests.ymlnever installs — this is a deliberate, self-documented pattern (their own docstrings explain it), just not what the README said. Corrected all four mentions to "18/26 in CI, 26/26 with optional extras."No eval metrics (leakage_rate, recall, precision, etc.) were touched — those need GROQ_API_KEY/network this environment can't reliably reach, per this repo's own CLAUDE.md rule.
No code defects found in
src/preshow/,evals/, orwebapp/during this pass.