Skip to content

docs: correct stale Default-OFF claim in retrieve_v2 docstring - #768

Merged
github-actions[bot] merged 1 commit into
mainfrom
docs/hrr-structural-default-on-docstring
May 14, 2026
Merged

docs: correct stale Default-OFF claim in retrieve_v2 docstring#768
github-actions[bot] merged 1 commit into
mainfrom
docs/hrr-structural-default-on-docstring

Conversation

@robotrocketscience

Copy link
Copy Markdown
Owner

Summary

retrieval.py:1870-1872 (inside the retrieve_v2 docstring, use_hrr_structural parameter description) still claimed "Default-OFF until the #437 reproducibility harness clears." That gate cleared at 11/11 and is_hrr_structural_enabled() (retrieval.py:818-848) has resolved to True for 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 in retrieve_v2 was stale.

Discovered while auditing v3.0.1 adapter defaults: the stale comment caused a false read that the structural lane shipped OFF.

Change

  • Update the use_hrr_structural parameter block to state Default-ON, reference the cleared gate, and list the three opt-out paths (env var, kwarg, TOML).
  • No behavior change.

Test plan

@coderabbitai

coderabbitai Bot commented May 13, 2026

Copy link
Copy Markdown

Important

Review skipped

Ignore keyword(s) in the title.

⛔ Ignored keywords (2)
  • docs:
  • release:

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 7316e2e0-562d-4f6b-888a-bb910a5e84e1

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/hrr-structural-default-on-docstring

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry @robotrocketscience, you have reached your weekly rate limit of 500000 diff characters.

Please try again later or upgrade to continue using Sourcery

@robotrocketscience

Copy link
Copy Markdown
Owner Author

[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.
@robotrocketscience
robotrocketscience force-pushed the docs/hrr-structural-default-on-docstring branch from 6f300a6 to e7a521c Compare May 14, 2026 04:29
@robotrocketscience

Copy link
Copy Markdown
Owner Author

Rebased onto github/main (1 commit e7a521cb, signed G). Verified:

  • Stale claim: only the retrieve_v2 docstring carried the Default-OFF until #437 wording. is_hrr_structural_enabled() at retrieval.py:825 returns True for no-override, and its own docstring (lines 829-833) already states post-flip behavior. PR closes the consumer-side gap.
  • git grep 'Default-OFF until the #437' github/main returns only the line being edited.
  • Diff is docstring-only — no behavior change, no code path touched.
  • All required checks green after rebase (pytest 3.12/3.13, secrets-scan, pattern-scan, history-scan, CodeQL, deptry, vulture, typos, commit-msg-prefix, pr-title-prefix, pr-body-issue-link).
  • Discretion grep on diff vs main: clean.
  • Single commit signed.

Labeling ready-to-merge.

@robotrocketscience robotrocketscience added the ready-to-merge Trigger merge-train: FF main to this PR's head label May 14, 2026
@github-actions github-actions Bot removed the ready-to-merge Trigger merge-train: FF main to this PR's head label May 14, 2026
@github-actions
github-actions Bot merged commit e7a521c into main May 14, 2026
27 checks passed
@github-actions

Copy link
Copy Markdown

merge-train: merged e7a521cmain via FF push.

@robotrocketscience

Copy link
Copy Markdown
Owner Author

[release:review:fermat:2026-05-14T04:33:05Z]

robotrocketscience added a commit that referenced this pull request May 14, 2026
…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.
@robotrocketscience
robotrocketscience deleted the docs/hrr-structural-default-on-docstring branch May 14, 2026 04:43
robotrocketscience added a commit that referenced this pull request May 14, 2026
…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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant