From 0942dab2fdaaabfb2d3be05baf9641b1f6ab3cf1 Mon Sep 17 00:00:00 2001 From: Ivan Enderlin Date: Wed, 6 Nov 2024 13:09:37 +0100 Subject: [PATCH] doc(base): Document `Client::event_cache_store` a bit more. --- crates/matrix-sdk-base/src/store/mod.rs | 3 +++ 1 file changed, 3 insertions(+) diff --git a/crates/matrix-sdk-base/src/store/mod.rs b/crates/matrix-sdk-base/src/store/mod.rs index 8e430ecdd30..b68b668009c 100644 --- 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(mut self, event_cache_store: S, key: String, holder: String) -> Self where S: event_cache_store::IntoEventCacheStore,