Skip to content

Commit 27f2cd3

Browse files
committed
docs(sdk): document features needed for store_path
If default features `sled_state_store` and `sled_cryptostore` aren't enabled, then passing a store path to the Client does nothing.
1 parent c79e62d commit 27f2cd3

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

crates/matrix-sdk/src/config/client.rs

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -127,10 +127,11 @@ impl ClientConfig {
127127
/// * `path` - The path where the stores should save data in. It is the
128128
/// callers responsibility to make sure that the path exists.
129129
///
130-
/// In the default configuration the client will open default
131-
/// implementations for the crypto store and the state store. It will use
132-
/// the given path to open the stores. If no path is provided no store will
133-
/// be opened
130+
/// In the default configuration, and if the corresponding features
131+
/// (`sled_state_store` and `sled_cryptostore`) are enabled, the client will
132+
/// open default implementations for the crypto store and the state store.
133+
/// It will use the given path to open the stores. If no path is provided no
134+
/// store will be opened
134135
#[must_use]
135136
pub fn store_path(mut self, path: impl AsRef<Path>) -> Self {
136137
self.base_config = self.base_config.store_path(path);

0 commit comments

Comments
 (0)