on master help sign in
Improve 'reaperAction' doc
00a5428ChShersh
auto-update/ChangeLog.md+5
@@ -1,3 +1,8 @@
1+## 0.1.4.1
2+
3+* [#693](https://github.com/yesodweb/wai/pull/693):
4+ Improve documentation for `reaperAction` function.
5+
1## 0.1.4
6## 0.1.4
2
7
3* Provide updateActionModify API in AutoUpdate [#547](https://github.com/yesodweb/wai/pull/547)
8* Provide updateActionModify API in AutoUpdate [#547](https://github.com/yesodweb/wai/pull/547)
auto-update/Control/Reaper.hs+3−2
@@ -49,8 +49,9 @@ data ReaperSettings workload item = ReaperSettings
49 -- ^ The action to perform on a workload. The result of this is a
49 -- ^ The action to perform on a workload. The result of this is a
50 -- \"workload modifying\" function. In the common case of using lists,
50 -- \"workload modifying\" function. In the common case of using lists,
51 -- the result should be a difference list that prepends the remaining
51 -- the result should be a difference list that prepends the remaining
52− -- workload to the temporary workload. For help with setting up such
52+ -- workload to the temporary workload. The temporary workload here
53+ -- refers to items added to the workload while the reaper action is
53− -- an action, see 'mkListAction'.
54+ -- running. For help with setting up such an action, see 'mkListAction'.
54 --
55 --
55 -- Default: do nothing with the workload, and then prepend it to the
56 -- Default: do nothing with the workload, and then prepend it to the
56 -- temporary workload. This is incredibly useless; you should
57 -- temporary workload. This is incredibly useless; you should
auto-update/auto-update.cabal+1−1
@@ -1,5 +1,5 @@
1name: auto-update
1name: auto-update
2−version: 0.1.4
2+version: 0.1.4.1
3synopsis: Efficiently run periodic, on-demand actions
3synopsis: Efficiently run periodic, on-demand actions
4description: API docs and the README are available at <http://www.stackage.org/package/auto-update>.
4description: API docs and the README are available at <http://www.stackage.org/package/auto-update>.
5homepage: https://github.com/yesodweb/wai
5homepage: https://github.com/yesodweb/wai