From ea7e299663cd693921027204a6b0e07005a344ef Mon Sep 17 00:00:00 2001 From: ManyTheFish Date: Tue, 11 Mar 2025 16:48:55 +0100 Subject: [PATCH] Update has_changed_for_fields documentation --- crates/milli/src/update/new/document_change.rs | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/crates/milli/src/update/new/document_change.rs b/crates/milli/src/update/new/document_change.rs index c790b4d32..38369a4d7 100644 --- a/crates/milli/src/update/new/document_change.rs +++ b/crates/milli/src/update/new/document_change.rs @@ -167,10 +167,12 @@ impl<'doc> Update<'doc> { } } - /// Returns whether the updated version of the document is different from the current version for the passed subset of fields. + /// Returns whether the updated version of the document is different from the current version for the subset of fields selected by `selector`. /// - /// `true` if at least one top-level-field that is a exactly a member of field or a parent of a member of field changed. + /// `true` if at least one top-level-field that is exactly a selected field or a parent of a selected field changed. /// Otherwise `false`. + /// + /// - Note: `_geo` and `_vectors` are not taken into account by this function. pub fn has_changed_for_fields<'t, Mapper: FieldIdMapper>( &self, selector: &mut impl FnMut(&str) -> PatternMatch,