Merge branch 'doc-store-path-feature'

2022-02-01 13:53:31 +01:00
parent ac7f2c94fb d09792e402
commit fe2323cd33
1 changed files with 5 additions and 4 deletions
@@ -127,10 +127,11 @@ impl ClientConfig {
    /// * `path` - The path where the stores should save data in. It is the
    /// callers responsibility to make sure that the path exists.
    ///
-    /// In the default configuration the client will open default
-    /// implementations for the crypto store and the state store. It will use
-    /// the given path to open the stores. If no path is provided no store will
-    /// be opened
+    /// In the default configuration, and if the corresponding features
+    /// (`sled_state_store` and `sled_cryptostore`) are enabled, the client will
+    /// open default implementations for the crypto store and the state store.
+    /// It will use the given path to open the stores. If no path is provided an
+    /// in-memory store will be opened.
    #[must_use]
    pub fn store_path(mut self, path: impl AsRef<Path>) -> Self {
        self.base_config = self.base_config.store_path(path);