docs: correct stale Default-OFF claim in retrieve_v2 docstring - #768
Conversation
|
Important Review skippedIgnore keyword(s) in the title. ⛔ Ignored keywords (2)
Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
There was a problem hiding this comment.
Sorry @robotrocketscience, you have reached your weekly rate limit of 500000 diff characters.
Please try again later or upgrade to continue using Sourcery
|
[claim:review:fermat:2026-05-14T04:27:08Z] |
The `use_hrr_structural` parameter description in `retrieve_v2`'s docstring (`retrieval.py:1870-1872`) still claimed "Default-OFF until the #437 reproducibility harness clears." The gate cleared at 11/11 and `is_hrr_structural_enabled()` (`retrieval.py:818-848`) has returned True for the no-override case since the #154 composition- tracker flip. The resolver's own docstring at line 829-833 already documents this; only the consumer-side `retrieve_v2` block was stale. Update the block to (a) state Default-ON, (b) reference the cleared gate, and (c) list the three opt-out paths (env var, kwarg, TOML). No behavior change.
6f300a6 to
e7a521c
Compare
|
Rebased onto github/main (1 commit
Labeling |
|
merge-train: merged e7a521c → |
|
[release:review:fermat:2026-05-14T04:33:05Z] |
…ration notes The prior note asserted v3.0.1 'ships with that default OFF pending #437 reproducibility-harness clearance' — that is wrong. is_hrr_structural_enabled (src/aelfrice/retrieval.py:825-854 post-#154 composition tracker) returns True by default when no env / kwarg / TOML override is set, and the #437 gate cleared at 11/11. PR #768 (merged) corrected the identical stale claim in retrieve_v2's docstring. The measurement itself stands — AELFRICE_HRR_STRUCTURAL=1 was set explicitly, so the methodology-match parity vs v2.2.2 holds. Re- framed the calibration note so anyone diffing the JSON later sees that this capture and the default-config measurement now agree.
…ration notes The prior note asserted v3.0.1 'ships with that default OFF pending #437 reproducibility-harness clearance' — that is wrong. is_hrr_structural_enabled (src/aelfrice/retrieval.py:825-854 post-#154 composition tracker) returns True by default when no env / kwarg / TOML override is set, and the #437 gate cleared at 11/11. PR #768 (merged) corrected the identical stale claim in retrieve_v2's docstring. The measurement itself stands — AELFRICE_HRR_STRUCTURAL=1 was set explicitly, so the methodology-match parity vs v2.2.2 holds. Re- framed the calibration note so anyone diffing the JSON later sees that this capture and the default-config measurement now agree.
Summary
retrieval.py:1870-1872(inside theretrieve_v2docstring,use_hrr_structuralparameter description) still claimed "Default-OFF until the #437 reproducibility harness clears." That gate cleared at 11/11 andis_hrr_structural_enabled()(retrieval.py:818-848) has resolved toTruefor the no-override case since the #154 composition-tracker flip. The resolver's own docstring at lines 829-833 already documents this — only the consumer-side block inretrieve_v2was stale.Discovered while auditing v3.0.1 adapter defaults: the stale comment caused a false read that the structural lane shipped OFF.
Change
use_hrr_structuralparameter block to state Default-ON, reference the cleared gate, and list the three opt-out paths (env var, kwarg, TOML).Test plan
git diffshows docstring-only change.benchmarks/results/v2.0.0.jsonis canonical,uv sync && aelf bench all#437" wording.