Skip to content

Commit 26ab4a5

Browse files
committed
fix(docs): drop private intra-doc link in lance_dataset_create_vector_index
Rustdoc with -D warnings rejects intra-doc links from public items to private ones. Replace the [`build_vector_params`] reference with a plain-text description of the validation behavior.
1 parent 3404636 commit 26ab4a5

1 file changed

Lines changed: 2 additions & 1 deletion

File tree

src/index.rs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -423,7 +423,8 @@ fn build_vector_params(p: &LanceVectorIndexParams) -> Result<LanceCoreVectorInde
423423
/// Create a vector index on a column.
424424
///
425425
/// `params.index_type` selects the variant; the rest of the fields are
426-
/// validated against that variant by [`build_vector_params`].
426+
/// validated against that variant (missing required fields produce a
427+
/// descriptive error naming the field).
427428
#[unsafe(no_mangle)]
428429
pub unsafe extern "C" fn lance_dataset_create_vector_index(
429430
dataset: *mut LanceDataset,

0 commit comments

Comments
 (0)