docs(knn): drop private intra-doc link that fails rustdoc on main - #9410
Merged
hamersaw merged 1 commit intoSep 18, 2026
Merged
Conversation
`KNNVectorDistanceExec::with_k` is public but its doc comment linked to the crate-private `try_new_batch`, which `-D warnings` rejects via `rustdoc::private_intra_doc_links`. Refer to the constructor with plain code formatting instead so `cargo doc --workspace --no-deps` passes again. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
github-actions
Bot
added
the
documentation
![lance-gatekeeper[bot]](https://avatars.githubusercontent.com/in/4433141?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
✅ Gate recommendation: approve.
Keeping try_new_batch crate-private while rendering its name as code is the minimal fix: it preserves the with_k validation explanation without exposing an internal constructor solely to make rustdoc resolve a link.
lance-gatekeeper
Bot
added
the
K-approved
wkalt
approved these changes
Sep 18, 2026
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
2 participants
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.
The
rustdocjob onmainhas been failing since #9334 merged:https://github.com/lance-format/lance/actions/runs/35372502724/job/105689817498
KNNVectorDistanceExec::with_kis public but its doc comment linked to thecrate-private
try_new_batch, whichRUSTDOCFLAGS="-D warnings"rejects viarustdoc::private_intra_doc_links. This refers to the constructor with plaincode formatting instead. The failing check was already red on #9334 itself, it
just is not a required check.
Verified locally with
RUSTDOCFLAGS="-D warnings" cargo doc --workspace --no-deps,cargo fmt --all -- --check, andcargo clippy --all --tests --benches -- -D warnings.🤖 Generated with Claude Code