doc(base): Document Client::event_cache_store a bit more.

matrix-org · Nov 6, 2024 · 0942dab · 0942dab
1 parent 94bd421
commit 0942dab
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/crates/matrix-sdk-base/src/store/mod.rs b/crates/matrix-sdk-base/src/store/mod.rs
@@ -531,6 +531,9 @@ impl StoreConfig {
     }
 
     /// Set a custom implementation of an `EventCacheStore`.
+    ///
+    /// The `key` and `holder` arguments represent the key and holder inside the
+    /// [`CrossProcessStoreLock::new`][matrix_sdk_common::store_locks::CrossProcessStoreLock::new].
     pub fn event_cache_store<S>(mut self, event_cache_store: S, key: String, holder: String) -> Self
     where
         S: event_cache_store::IntoEventCacheStore,