From 47e213181a1ad0bc067905674c524097191da110 Mon Sep 17 00:00:00 2001
From: Eric Bailey <git@esb.lol>
Date: Mon, 16 Sep 2024 09:46:35 -0500
Subject: [PATCH] Add some comments

---
 src/state/persisted/schema.ts | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/src/state/persisted/schema.ts b/src/state/persisted/schema.ts
index 331a111a2e..2a3e49bfc1 100644
--- a/src/state/persisted/schema.ts
+++ b/src/state/persisted/schema.ts
@@ -55,10 +55,27 @@ const schema = z.object({
     lastEmailConfirm: z.string().optional(),
   }),
   languagePrefs: z.object({
+    /**
+     * Used as the target for translations.
+     */
     primaryLanguage: z.string(), // should move to server
+    /**
+     * The languages the user can read, passed to feeds.
+     */
     contentLanguages: z.array(z.string()), // should move to server
+    /**
+     * The language the user is currently posting in, configured within the
+     * composer.
+     */
     postLanguage: z.string(), // should move to server
+    /**
+     * The user's post language history, used to pre-populate the post language
+     * selector in the composer.
+     */
     postLanguageHistory: z.array(z.string()),
+    /**
+     * The language for all UI translations in the app.
+     */
     appLanguage: z.string(),
   }),
   requireAltTextEnabled: z.boolean(), // should move to server