From f368fc4dc5acf459cb65a366143fd10f4729ed70 Mon Sep 17 00:00:00 2001
From: Felix Paulusma <felix.paulusma@gmail.com>
Date: Sat, 2 Nov 2024 11:11:04 +0100
Subject: [PATCH] auto-update: added documentation to new settings fields and
 bumped version to 0.2.3

---
 auto-update/Control/AutoUpdate.hs        | 5 +++++
 auto-update/Control/Debounce/Internal.hs | 5 +++++
 auto-update/Control/Reaper.hs            | 5 +++++
 auto-update/auto-update.cabal            | 2 +-
 4 files changed, 16 insertions(+), 1 deletion(-)

diff --git a/auto-update/Control/AutoUpdate.hs b/auto-update/Control/AutoUpdate.hs
index c8faac5ec..0c67a3be4 100644
--- a/auto-update/Control/AutoUpdate.hs
+++ b/auto-update/Control/AutoUpdate.hs
@@ -115,6 +115,11 @@ data UpdateSettings a = UpdateSettings
     --
     -- @since 0.1.0
     , updateThreadName :: String
+    -- ^ Label of the thread being forked.
+    --
+    -- Default: @"AutoUpdate"@
+    --
+    -- @since 0.2.2
     }
 
 -- | Generate an action which will either read from an automatically
diff --git a/auto-update/Control/Debounce/Internal.hs b/auto-update/Control/Debounce/Internal.hs
index 7e30c71f9..bad5ce403 100644
--- a/auto-update/Control/Debounce/Internal.hs
+++ b/auto-update/Control/Debounce/Internal.hs
@@ -58,6 +58,11 @@ data DebounceSettings = DebounceSettings
     --
     -- @since 0.1.6
     , debounceThreadName :: String
+    -- ^ Label of the thread spawned when debouncing.
+    --
+    -- Default: @"Debounce"@.
+    --
+    -- @since 0.2.2
     }
 
 -- | Setting to control whether the action happens at the leading and/or trailing
diff --git a/auto-update/Control/Reaper.hs b/auto-update/Control/Reaper.hs
index 5f136dde3..0f1d76cb7 100644
--- a/auto-update/Control/Reaper.hs
+++ b/auto-update/Control/Reaper.hs
@@ -96,6 +96,11 @@ data ReaperSettings workload item = ReaperSettings
     --
     -- @since 0.1.1
     , reaperThreadName :: String
+    -- ^ Label of the thread spawned by the reaper.
+    --
+    -- Default: @"Reaper"@.
+    --
+    -- @since 0.2.2
     }
 
 -- | Default @ReaperSettings@ value, biased towards having a list of work
diff --git a/auto-update/auto-update.cabal b/auto-update/auto-update.cabal
index ccac45c1b..3bb537197 100644
--- a/auto-update/auto-update.cabal
+++ b/auto-update/auto-update.cabal
@@ -1,5 +1,5 @@
 name:                auto-update
-version:             0.2.2
+version:             0.2.3
 synopsis:            Efficiently run periodic, on-demand actions
 description:         API docs and the README are available at <http://www.stackage.org/package/auto-update>.
 homepage:            https://github.com/yesodweb/wai