chore: add known gotchas to agent docs for ref refiner#3286
Merged
Conversation
📊 Code Quality Score: 1/100
Scored by GitVelocity · How are scores calculated? |
yodem
approved these changes
May 11, 2026
📊 Code Quality Score: 1/100
Scored by GitVelocity · How are scores calculated? |
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
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.
This pull request adds a new "Known Gotchas" section to the
agent_docs/model/linker/ref_resolver.mddocumentation. The section highlights several subtle issues and edge cases in the ibid resolution logic, helping developers understand potential pitfalls in the current implementation.Key documentation updates:
Known limitations and edge cases in ibid resolution
is_empty()can cause correct ibid resolutions to be dropped if the target book has no text for a section, potentially resulting in the wrong book being selected.base_text_titles, which can result in both section-context and context-free refinement producing valid refs, allowing incorrect books to survive to the pruning stage.crrd, clarifying how the grouping of numbered parts before and after a range symbol works.