Skip to content

Commit

Permalink
auto-update: added documentation to new settings fields and bumped ve…
Browse files Browse the repository at this point in the history
…rsion to 0.2.3
  • Loading branch information
Vlix committed Nov 2, 2024
1 parent df0c20e commit f368fc4
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 1 deletion.
5 changes: 5 additions & 0 deletions auto-update/Control/AutoUpdate.hs
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 5 additions & 0 deletions auto-update/Control/Debounce/Internal.hs
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 5 additions & 0 deletions auto-update/Control/Reaper.hs
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion auto-update/auto-update.cabal
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit f368fc4

Please sign in to comment.