From 2a9293cf3b94cff6572f14c56d34c4f06a10ad57 Mon Sep 17 00:00:00 2001
From: Nik Clayton <nik@ngo.org.uk>
Date: Fri, 18 Oct 2024 01:29:39 +0200
Subject: [PATCH] change: Document the WELLBEING_* preferences (#1010)

---
 .../pachli/core/preferences/SettingsConstants.kt   | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/core/preferences/src/main/kotlin/app/pachli/core/preferences/SettingsConstants.kt b/core/preferences/src/main/kotlin/app/pachli/core/preferences/SettingsConstants.kt
index c618987dd..183d978ec 100644
--- a/core/preferences/src/main/kotlin/app/pachli/core/preferences/SettingsConstants.kt
+++ b/core/preferences/src/main/kotlin/app/pachli/core/preferences/SettingsConstants.kt
@@ -59,7 +59,21 @@ object PrefKeys {
     const val SHOW_STATS_INLINE = "showStatsInline"
 
     const val CUSTOM_TABS = "customTabs"
+
+    /**
+     * True if post stats (# boosts, # favourites) are hidden in a
+     * status' detailed view. False to show them.
+     */
     const val WELLBEING_HIDE_STATS_POSTS = "wellbeingHideStatsPosts"
+
+    /**
+     * True if the following should be hidden on profile pages:
+     *
+     * - Whether or not the account follows you
+     * - # statuses posted by this account
+     * - # followers this account has
+     * - # accounts this account is following
+     */
     const val WELLBEING_HIDE_STATS_PROFILE = "wellbeingHideStatsProfile"
 
     const val HTTP_PROXY_ENABLED = "httpProxyEnabled"