Fix doc

element-hq · Jan 15, 2025 · ae163d1 · ae163d1
1 parent bef3165
commit ae163d1
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/src/components/views/settings/encryption/RecoveryPanel.tsx b/src/components/views/settings/encryption/RecoveryPanel.tsx
@@ -20,7 +20,7 @@ import { SettingsSubheader } from "../SettingsSubheader";
  * The possible states of the recovery panel.
  * - `loading`: We are checking the recovery key and the secrets.
  * - `missing_recovery_key`: The user has no recovery key.
- * - `secrets_not_cached`: The user has a backup but the secrets are not cached.
+ * - `secrets_not_cached`: The user has a recovery key but the secrets are not cached.
  *                         This can happen if we verified another device and secret-gossiping failed, or the other device itself lacked the secrets.
  * - `good`: The user has a recovery key and the secrets are cached.
  */
@@ -30,8 +30,8 @@ interface RecoveryPanelProps {
     /**
      * Callback for when the user wants to set up or change their recovery key.
      *
-     * @param setupNewKeyis set if the user does not already have a recovery key (and has therefore clicked on
-     * "Set up recovery" rather than "Change recovery key").
+     * @param setupNewKey - set if the user does not already have a recovery key (and has therefore clicked on
+     *                      "Set up recovery" rather than "Change recovery key").
      */
     onChangeRecoveryKeyClick: (setupNewKey: boolean) => void;
 }

diff --git a/src/components/views/settings/tabs/user/EncryptionUserSettingsTab.tsx b/src/components/views/settings/tabs/user/EncryptionUserSettingsTab.tsx
@@ -26,7 +26,7 @@ import { SettingsSubheader } from "../../SettingsSubheader";
  *  - "set_up_encryption": The panel to show when the user is setting up their encryption.
  *                         This happens when the user doesn't have cross-signing enabled, or their current device is not verified.
  *  - "change_recovery_key": The panel to show when the user is changing their recovery key.
- *                           This happens when the user has a key backup and the user clicks on "Change recovery key" button of the RecoveryPanel.
+ *                           This happens when the user has a recovery key and the user clicks on "Change recovery key" button of the RecoveryPanel.
  *  - "set_recovery_key": The panel to show when the user is setting up their recovery key.
  *                        This happens when the user doesn't have a key a recovery key and the user clicks on "Set up recovery key" button of the RecoveryPanel.
  */