on master help sign in
Merge pull request #694 from ChShersh/master

Improve 'reaperAction' doc

commitda08a4fec82e25aa91aab4147f4172b97aee9bda authorMichael Snoyman <michael@snoyman.com> dateMon 18 Jun 2018, 16:11 (8 years ago) parent0678ddd00a5428
3 files changed+9−3
auto-update/ChangeLog.md+5 auto-update/Control/Reaper.hs+3−2 auto-update/auto-update.cabal+1−1
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+
16## 0.1.4
27
38* 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
4949 -- ^ The action to perform on a workload. The result of this is a
5050 -- \"workload modifying\" function. In the common case of using lists,
5151 -- the result should be a difference list that prepends the remaining
52− -- workload to the temporary workload. For help with setting up such
53− -- an action, see 'mkListAction'.
52+ -- workload to the temporary workload. The temporary workload here
53+ -- refers to items added to the workload while the reaper action is
54+ -- running. For help with setting up such an action, see 'mkListAction'.
5455 --
5556 -- Default: do nothing with the workload, and then prepend it to the
5657 -- temporary workload. This is incredibly useless; you should
auto-update/auto-update.cabal+1−1
@@ -1,5 +1,5 @@
11name: auto-update
2−version: 0.1.4
2+version: 0.1.4.1
33synopsis: Efficiently run periodic, on-demand actions
44description: API docs and the README are available at <http://www.stackage.org/package/auto-update>.
55homepage: https://github.com/yesodweb/wai