docs(index): document public API of LogicalScalarIndex#6804
Conversation
Add rustdoc to the LogicalScalarIndex struct and the two public loader functions (open_named_scalar_index, scalar_index_fragment_bitmap), covering when the wrapper is used, the same-index-type constraint, how SearchResult precision is combined across segments, and the read-only remap/update behavior. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
github-actions
Bot
added
the
documentation
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
|
@claude review once |
![claude[bot]](https://avatars.githubusercontent.com/in/1236702?s=60&v=4){kind=small}
There was a problem hiding this comment.
LGTM — pure rustdoc additions, no logic changes.
Extended reasoning...
Overview
This PR adds rustdoc comments to three public items in rust/lance/src/index/scalar_logical.rs: the LogicalScalarIndex struct and the two public loader functions (open_named_scalar_index, scalar_index_fragment_bitmap). No code logic, signatures, or behavior changes.
Security risks
None. Documentation-only change with no impact on runtime behavior, data handling, or trust boundaries.
Level of scrutiny
Minimal scrutiny required. The diff is entirely /// doc comments above existing items. I spot-checked that the documented behavior matches the actual code: the same-index-type constraint in try_new, the SearchResult precision combination logic in combine_search_results (Exact ∪ Exact = Exact; any AtMost → AtMost; any AtLeast → AtLeast; AtMost+AtLeast errors), and the read-only remap/update returning errors — all match the doc text accurately.
Other factors
The PR author (westonpace) explicitly requested a review. The bug hunting system found no issues, and Codecov reports full coverage on modified lines (trivially true for doc-only changes). Safe to approve without human review.
1 participant
Add rustdoc to the LogicalScalarIndex struct and the two public loader functions (open_named_scalar_index, scalar_index_fragment_bitmap), covering when the wrapper is used, the same-index-type constraint, how SearchResult precision is combined across segments, and the read-only remap/update behavior.