Skip to content

docs(leftover): align cross share with raw residual - #599

Merged
seonghobae merged 4 commits into
mainfrom
codex/cross-share-doc-consistency-20260825
Aug 25, 2026
Merged

docs(leftover): align cross share with raw residual#599
seonghobae merged 4 commits into
mainfrom
codex/cross-share-doc-consistency-20260825

Conversation

@seonghobae

@seonghobae seonghobae commented Aug 25, 2026

Copy link
Copy Markdown
Contributor

Summary

  • align ADR 0003/0048/0049 and migration 0185 with the implemented and tested identity x = 2 R̂ U / R²
  • remove the contradictory centered-residual wording without changing any estimator or weight
  • retain ADR 0182/0186 ownership of signed unexplained leftover and reconstruction fields

Verification

  • uv run pytest -q tests/test_documentation_hygiene.py tests/test_migration_replay.py (11 passed)
  • git diff --check

Follow-up to the documentation finding that arrived as PR #563 crossed the protected merge boundary.


Open in Devin Review

Summary by CodeRabbit

  • 변경 사항
    • 잔여 맵의 교차 공유 계산 기준이 중심화된 잔차에서 원시 잔차로 변경되었습니다.
    • 이에 따라 보고서에 표시되는 교차 공유 값이 새로운 계산 기준을 반영합니다.
    • 관련 의사결정 기록과 데이터베이스 마이그레이션 설명을 업데이트했습니다.
    • 두 축 재구성 값은 별도로 저장하지 않으며, 저장 시 별도 승인이 필요하다는 정책을 명확히 했습니다.

@coderabbitai

coderabbitai Bot commented Aug 25, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

Next included review available in 56 minutes.

View limit details

Limit details: You’ve used the included review currently available.

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 1786c7a3-51d5-449b-a892-1a87a8b2fec3

📥 Commits

Reviewing files that changed from the base of the PR and between be3314e and 205b8a5.

📒 Files selected for processing (1)
  • migrations/0185_report_leftover_map_cross_share.sql

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 20a8fa57-2a88-4754-98f0-a26cfea28080

📥 Commits

Reviewing files that changed from the base of the PR and between b7714c5 and be3314e.

📒 Files selected for processing (4)
  • docs/adr/0003-fast-mlsirm-report-integration.md
  • docs/adr/0048-persist-lsirm-leftover-pairs.md
  • docs/adr/0049-leftover-pair-report-ui.md
  • migrations/0185_report_leftover_map_cross_share.sql

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

cross-share 정의가 centered leftover 기반에서 raw residual 기반으로 변경되었습니다. 관련 ADR과 마이그레이션 설명이 새 공식과 영속화하지 않는 필드를 반영하도록 갱신되었습니다.

Changes

Leftover cross-share 정의 변경

Layer / File(s) Summary
Raw residual 기반 정의와 영속화 설명 갱신
docs/adr/0003-fast-mlsirm-report-integration.md, docs/adr/0048-persist-lsirm-leftover-pairs.md, docs/adr/0049-leftover-pair-report-ui.md, migrations/0185_report_leftover_map_cross_share.sql
cross-share 계산이 x = 2 R̂ U / R²를 사용하도록 변경되었습니다. centered leftover 기반 표현이 제거되었습니다. 지원되지 않는 share 별칭과 별도 재구성 컬럼의 저장 관련 설명이 갱신되었습니다.

Estimated code review effort: 2 (Simple) | ~10 minutes

Merge Risk: ⚪ Minimal · up to be331

This PR aligns documentation and migration wording with the implemented residual-share identity without changing estimator or weighting behavior; no actionable merge-blocking risk remains after normal checks and review.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed PR 제목은 leftover cross share 문서를 raw residual 기준으로 정렬하는 주요 변경을 정확하고 간결하게 설명합니다.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (4 skipped: 4 unsupported.)

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/cross-share-doc-consistency-20260825

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.

@seonghobae
seonghobae enabled auto-merge August 25, 2026 03:28
devin-ai-integration[bot]

This comment was marked as resolved.

@opencode-agent
opencode-agent Bot disabled auto-merge August 25, 2026 03:40
@seonghobae
seonghobae enabled auto-merge (squash) August 25, 2026 03:41
devin-ai-integration[bot]

This comment was marked as resolved.

@seonghobae
seonghobae merged commit 3ac4ff1 into main Aug 25, 2026
28 of 30 checks passed
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