improve doc

matrix-org · Nov 13, 2024 · ccc07bb · ccc07bb
1 parent 3dc3d9a
commit ccc07bb
Showing 1 changed file with 5 additions and 1 deletion.
diff --git 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