doc: align version-guard, loop-helper, and reclassify docs with the code - #1013
Conversation
Three codex findings on PR #1012, all stale-claim class. The pysimlin version-tag guard's comment and skip message described CI as a tagless shallow clone, the opposite of what ci.yaml's fetch-tags checkout does -- an unexpected skip would have been misread as normal CI behavior. The engine module map still listed ltm::detect_loops, and reclassify_loops_from_results' rustdoc still described a Python slot-0 reclassification path and a Run.loops_runtime property; pysimlin's Run.loops rides this helper via Sim.get_loops_runtime, so the A2A note is a two-site comparison (this helper's all-slots concatenation vs discovery's strongest-path scalar), not three.
|
@codex review |
|
Reviewed. This is a docs-only alignment PR and all three claims check out against the code:
No findings — LGTM. Overall correctness verdict: CORRECT. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1013 +/- ##
=======================================
Coverage 92.18% 92.18%
=======================================
Files 247 247
Lines 158229 158229
=======================================
+ Hits 145856 145857 +1
+ Misses 12373 12372 -1 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: f07b463958
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| visible. CI fetches tags (fetch-tags: true in ci.yaml), so this skip is \ | ||
| expected only on a local clone without them; run `git fetch --tags` to \ |
There was a problem hiding this comment.
Limit the no-tag diagnostic to the Build job
In the Code Coverage job, .github/workflows/ci.yaml:116-117 uses the default checkout without fetch-tags, while .github/workflows/ci.yaml:161-163 runs every workspace test, including this one. That job will therefore legitimately take this branch in CI, so saying the skip is expected only on a local clone misattributes a normal coverage run. Either fetch tags in the coverage checkout too or clarify that only the Build job guarantees them.
Useful? React with 👍 / 👎.
Follow-up to #1012, addressing the three codex review findings that arrived as it merged. All three are the stale-claim class: documentation describing a state of the world the code no longer has.
simlin-mcpversion guard: the comment and skip message described CI as a tagless shallow clone where the guard "is a no-op" — the opposite of whatci.yaml'sfetch-tags: truecheckout (added in tests: remove implementation-asserting tests repo-wide #1012) does. An unexpected skip in CI would have been misread as documented-normal behavior. Both now state that CI fetches tags specifically so the guard runs, and that a skip is expected only on a local clone without them. (Verified live: with the freshpysimlin-v0.8.0tag fetched, the guard passes against the 0.8.0 release.)src/ltm/still advertised the deleted top-leveldetect_loopshelper; anyone following the documented surface would import a nonexistent API.reclassify_loops_from_resultsrustdoc: claimed pysimlinRun.loops"still reclassifies via its own PythonLoopPolarity.from_runtime_scoresmirror (slot-0 only)" and "exposes the all-slots engine path separately asRun.loops_runtime" — both false:Run.loopsrides this helper viaSim.get_loops_runtime, there is no separate property, and the Python classifier no longer exists. The A2A-semantics note is now correctly a two-site comparison (this helper's all-slots concatenation vs discovery's strongest-path scalar) instead of three.🤖 Generated with Claude Code
https://claude.ai/code/session_01S3vQ72pUeYXdMgCv7sSjaB