doc(encryption tab): improve RecoveryPanelOutOfSync documentation

element-hq · Jan 30, 2025 · afe59ef · afe59ef
1 parent bbb2b01
commit afe59ef
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/src/components/views/settings/encryption/RecoveryPanelOutOfSync.tsx b/src/components/views/settings/encryption/RecoveryPanelOutOfSync.tsx
@@ -22,7 +22,11 @@ interface RecoveryPanelOutOfSyncProps {
 }
 
 /**
- * This component is shown when the user secrets are not cached and the recovery key needs to be entered.
+ * This component is shown as part of the {@link EncryptionUserSettingsTab}, instead of the
+ * {@link RecoveryPanel}, when some of the user secrets are not cached in the local client.
+ *
+ * It prompts the user to enter their recovery key so that the secrets can be loaded from 4S into
+ * the client.
  */
 export function RecoveryPanelOutOfSync({ onFinish }: RecoveryPanelOutOfSyncProps): JSX.Element {
     return (