From ccc07bb44d2c7e4b6860301573d6e96de7a0a33e Mon Sep 17 00:00:00 2001
From: Florian Duros <florian.duros@ormaz.fr>
Date: Wed, 13 Nov 2024 14:24:51 +0100
Subject: [PATCH] improve doc

---
 src/crypto-api/index.ts | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/src/crypto-api/index.ts b/src/crypto-api/index.ts
index 84616869641..89ece07acbe 100644
--- a/src/crypto-api/index.ts
+++ b/src/crypto-api/index.ts
@@ -535,7 +535,11 @@ export interface CryptoApi {
     isKeyBackupTrusted(info: KeyBackupInfo): Promise<BackupTrustInfo>;
 
     /**
-     * Get information about the current key backup.
+     * Return the details of the latest backup on the server, when we last checked.
+     *
+     * This normally returns a cached value, but if we haven't yet made a request to the server, it will fire one off.
+     * It will always return the details of the active backup if key backup is enabled.
+     *
      * Return null if there is no backup.
      *
      * @returns the key backup information