docs(indexer): add documentation for build_attributes and build_chunk…

…_attributes methods
TabbyML · Oct 31, 2024 · 8e67917 · 8e67917
1 parent 9c8e6fd
commit 8e67917
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/crates/tabby-index/src/indexer.rs b/crates/tabby-index/src/indexer.rs
@@ -36,7 +36,10 @@ pub trait ToIndexId {
 
 #[async_trait::async_trait]
 pub trait IndexAttributeBuilder<T>: Send + Sync {
+    /// Build document level attributes, these attributes are only stored but not indexed.
     async fn build_attributes(&self, document: &T) -> serde_json::Value;
+
+    /// Build chunk level attributes, these attributes are stored and indexed.
     async fn build_chunk_attributes(
         &self,
         document: &T,