Repository navigation
test: drop history-only text from test docstrings (part 2) - #24559
Conversation
UX Review (Opus 5.5) — ⏭️ skippedRevision |
First Principles Review (Opus 5.5) — ⏭️ skippedRevision |
Design Review (Opus 5.5) — ✅ PASSDesign-level review of Design-Verdict: PASS The diff only changes wording in test docstrings and comments, and no test logic or behaviour changes, so there is nothing at the design level to judge. [DESIGN-REVIEWED] c418309 Description read[DESCRIPTION-READ] df34862350468c1a233daa5a868b9dfa67ed5fc3bee57021b6b0c7ce290c6719 That sha256 names everything this verdict read: the PR description, plus the 1 evidence file(s) the workflow collected from it and handed this review. It covers that evidence because the media strip replaces every attachment URL with the same placeholder, so an edit swapping one attachment for another would leave the description's captured text identical while what this review judged changed. Recompute it with |
Opus 5.5 Review — ✅ no blocking findingsReviewed Verdict parsed from the review's SHA-scoped output markers for commit False positive or not applicable? A repository writer can comment: |
GPT 6.1 Review — ✅ no blocking findingsGPT 6.1 completed its review of This comment is updated in place on each push. Review detailsNo findings. False positive or not applicable? A repository writer can comment: |
2146bb4 to
d60af90
Compare
|
Disposition: |
Cut review-round and reviewer-found narration from test docstrings, keeping the rule each test pins. Docstrings only; test code is unchanged.
d60af90 to
c418309
Compare
Problem / Motivation
Goal: Test docstrings state the rule each test pins, without review-round history.
Many test docstrings open with "(review finding)", "Four review rounds found...", "a reviewer caught...", commit SHAs or issue numbers. That text tells a reader how the test came to be, not what it guards, and it goes stale. This is part 2 of 2 (42 files,
test/test_issue_radar_crew_triage_model.pythroughtest/test_workspace_crud_handlers.py); part 1 is onchore/test-docstrings-history.Why it matters
A reader of a failing test needs the invariant and why it matters. History narration hides that and is what
scripts/check_comment_history.pyalready refuses on new lines.Not a goal
src/) changes.What changed (motivation → approach → change)
For each strict-rule history hit: cut the history; where the docstring also says what the test pins and why, kept that as the rule, stated in the present tense. No docstring that carried a real why was emptied. Long lines rewrapped to ≤100 columns.
Left as-is because review is the feature under test:
test/test_pr_readiness_evaluate.py:1672,test/test_pr_readiness_sweep.py:1373(changes-requested reviews)test/test_prepare_pr_findings.py:135,test/test_prepare_pr_monitor_armed.py:93,test/test_prepare_pr_profiles.py:294,test/test_prepare_pr_prove_line.py:239,:464(the prepare-PR review tooling)Strict history count for
test/(goal_scan.py history --strict): 132 → 80 on this branch (52 lines cut or rewritten). With part 1 merged as well: 132 → 10, all of them the feature-under-test hits above and in part 1.Backwards compatibility
Compatible: docstring text only; nothing is parsed from these strings.
Removes nothing: only docstring wording changes; no test, reader or behaviour is removed.
Tests
Proof: not provable -- test-only change
goal_scan.py astcheck 20c46e97d9(merge-base):-n 4,KIROCREW_PROFILE=standalone): 4893 passed, 16 skipped.check_black_formatting.pywith black 26.10.1) andcheck_comment_history.pypass.Manual verification
N/A — docstring-only change; AST check proves no code moved.
Related Issues
Part 1:
chore/test-docstrings-history.Checklist
feat|fix|docs|style|refactor|perf|test|chore|ci|build|revert: ...)Contribution License Agreement
Contributed under the project's Apache-2.0 license.