From 1e2fd02478e39cd7183041803633fbf1e1962fcd Mon Sep 17 00:00:00 2001
From: Jonas Platte <jplatte@matrix.org>
Date: Fri, 20 Jan 2023 10:03:40 +0100
Subject: [PATCH] doc(base): Explain purpose of BaseClient#crypto_store

---
 crates/matrix-sdk-base/src/client.rs | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/crates/matrix-sdk-base/src/client.rs b/crates/matrix-sdk-base/src/client.rs
index 62fcf78bf..ba5d452b0 100644
--- a/crates/matrix-sdk-base/src/client.rs
+++ b/crates/matrix-sdk-base/src/client.rs
@@ -77,7 +77,10 @@ use crate::{
 pub struct BaseClient {
     /// Database
     pub(crate) store: Store,
-    /// The store used for encryption
+    /// The store used for encryption.
+    ///
+    /// This field is only meant to be used for `OlmMachine` initialization.
+    /// All operations on it happen inside the `OlmMachine`.
     #[cfg(feature = "e2e-encryption")]
     crypto_store: Arc<dyn CryptoStore>,
     /// The olm-machine that is created once the