risundle が対応できるライブラリの条件を新規文書化する#93
Merged
Merged
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughSummary by CodeRabbit
Walkthroughライブラリのバンドル互換条件を英日ドキュメントとして追加し、READMEとcheatsheetから参照できるようにした。あわせて、実装対象の表現を「型名」から「名前」へ統一し、関連する仕様とソースコメントを更新した。 Changesライブラリ互換性ドキュメント
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related issues
Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
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 |
TwoSquirrels
force-pushed
the
docs/compatibility
branch
from
July 14, 2026 07:36
8fd6674 to
5d467d6
Compare
TwoSquirrels
force-pushed
the
docs/compatibility
branch
from
July 14, 2026 08:01
5d467d6 to
0da62d4
Compare
ファイルの自己完結性・マクロ生成の非対応・識別子検出の走査範囲など、 バンドルが正しく成立する十分条件を docs/compatibility.ja.md にまとめる。 spec.ja.md の「既知の制限」節はここへ移設し、README・cheatsheet からも リンクする。英語版は日本語版が固まってから翻訳してこの PR に足す。 Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
TwoSquirrels
force-pushed
the
docs/compatibility
branch
from
July 14, 2026 08:04
0da62d4 to
cc52d4c
Compare
生成される名前を素の前方宣言として同じファイルに書けば、登録時に 定義識別子として記録されファイルが維持されることを実験で確認した。 Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
cheatsheet はこれまでどこからもリンクされておらず、README を入口に する読者から辿れなかった。 Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
「開発」節のリンクは節名から利用者向けと伝わりにくいため、動作を 深く知りたい読者の動線として仕組みの直後にも一行置く。 Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
- 普通のヘッダーオンリーライブラリは無条件で満たすという安心材料 - 条件が問われるのは展開されるライブラリだけという適用範囲 - 解答は単一ソースファイルという前提 - クラス外実装の救済は実装先が登録済みライブラリ内で定義されている 場合に限る、という精度補正 (std::hash 特殊化だけのファイルは対象外) Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
文脈なしの読者による通読テストで見つかった問題を直す。 - 「黙って壊れない」という総括と名前空間ラッパー例の矛盾を解消し、 非修飾利用だけが唯一の例外であることを明示する - 壊れ方の数え上げを整理し、std::hash の段落を分類の外に出す - 未説明の内部用語「ダミー」を消し、keep 衝突の項を結論先行にする - 「系」「識別子照合」などの硬い語を平易にし、自動フォールバックに 一言の説明を添える - 記号演算子には前方宣言の救済が効かないことを明記する - 複数ソース制限とヘッダー分割の関係、ローカルヘッダー自体は丸ごと 残ることを補う Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
見出しが処方そのものだが、再テストの読者は本文に回避策が無いと 受け取ったため、一文で明示する。 Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
ダッシュ挿入 2 箇所を丸括弧に、プレゼン口調の前置きと「利点として 働く」を地の文に直す。 Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
日本語版で行った変更 (spec の既知の制限の移設、README の粒度表記と NOTE のエラー種別、cheatsheet の FAQ 追加) を英語側にミラーする。 両言語版に相互の言語リンク行も付ける。 Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
TwoSquirrels
marked this pull request as ready for review
July 15, 2026 00:18
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Around line 12-18: README.md lines 12-18: revise the English feature wording
to state that only headers and implementation files determined necessary for
bundling remain, not merely directly used headers. Apply the equivalent
clarification in README.ja.md lines 12-18. Update docs/cheatsheet.md line 48 and
docs/cheatsheet.ja.md line 48 to describe retaining files required by the bundle
rather than files directly used by main.cpp.
- Around line 20-21: Clarify the implementation-file behavior in the NOTE at
README.md lines 20-21 by stating that only already included files appearing in
the output are preserved and that implementation files must be explicitly
included alongside declarations; make the equivalent clarification in
README.ja.md lines 20-21, using wording that conveys only files appearing in the
output are retained and implementation files require explicit inclusion.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: b96e7771-67ae-418d-abf9-3550beaeb780
📒 Files selected for processing (8)
README.ja.mdREADME.mddocs/cheatsheet.ja.mddocs/cheatsheet.mddocs/compatibility.ja.mddocs/compatibility.mddocs/spec.ja.mddocs/spec.md
「実装ファイルを辿って維持します」が自動追加と誤読され得るという レビュー指摘への対応。維持の仕組み (実装先の型名) は README で説明 せず、「行儀の良いライブラリだけ対応」という結論と限界の例だけを 残して詳細は compatibility 文書へ誘導する。 Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
implements に記録されるのは型名に限らない (関数テンプレートの明示的 特殊化では関数名、修飾側が namespace のこともある) ため、実態に合う 呼び方へドキュメントとコードコメントを一括で改める。spec の定義文も 「どの型 (や関数テンプレート) の実装か」に正確化する。 Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/spec.ja.md`:
- Line 21: 実装対象名を型に限定する表現を、実装先の名前全般を示す表現へ統一してください。docs/spec.ja.md
の「どの型」、docs/spec.md の “which type”、および src/library/tags.rs
の「対象とする型名」を、関数テンプレートの主テンプレート名も含む「実装先の名前」または同等の表現に変更してください。
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 88b2c157-2f80-41df-87b1-96726aa4d6ab
📒 Files selected for processing (10)
README.ja.mdREADME.mddocs/architecture.mddocs/compatibility.ja.mddocs/compatibility.mddocs/spec.ja.mddocs/spec.mdsrc/bundle/inventory.rssrc/library/identifiers.rssrc/library/tags.rs
🚧 Files skipped from review as they are similar to previous changes (4)
- docs/compatibility.ja.md
- README.md
- README.ja.md
- docs/compatibility.md
「実装先の型名」の文字列一致だけで置換したため、言い回しの違う この 1 箇所が漏れていた (レビュー指摘)。 Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #20
概要
risundle が正しくバンドルできるための十分条件 (必要十分条件そのものではない) を
docs/compatibility.ja.md/docs/compatibility.mdに新規文書化する。namespaceで他ファイルの#includeをラップする構成 (黙ってスコープが変わりうる、唯一のサイレント破壊ケース)付随する変更
docs/spec.*の「既知の制限」節を compatibility へ移設し、リンクに置き換えREADME.*の謳い文句を「実際に使っている部分/コード」から「実際に使っているヘッダーファイル」へ正確化 (tree-shaking はファイル単位のため)README.*の NOTE を書き直し、維持の仕組みの説明をやめて compatibility への誘導に整理 (実装ファイルが自動追加されると誤読しうるというレビュー指摘への対応)docs/cheatsheet.*に「自分のライブラリが対応しているか確認したい」の FAQ を追加日本語版は文脈なしの読者によるテストを 2 巡実施し、指摘 (総括と例の矛盾、未説明の内部用語など) を反映済み。調査過程は #20 のコメント欄に記録している。
🤖 Generated with Claude Code