Documentation for Handler.Utils.Delete

2019-03-25 08:59:06 +01:00 · 2019-03-25 08:59:06 +01:00 · 973eeb18c0
commit 973eeb18c0
parent 4da1be96ee
1 changed files with 10 additions and 0 deletions
--- a/src/Handler/Utils/Delete.hs
+++ b/src/Handler/Utils/Delete.hs
@ -1,3 +1,13 @@
+{-|
+Module      : Handler.Utils.Delete
+Description : Generic deletion from database after confirmation
+
+`postDeleteR`, `getDeleteR`, and `deleteR` provide handlers for calling
+`deleteCascade` on a `Set` of Record-`Key`s after asking for confirmation, which
+currently entails asking the user to copy a text, which is dependent on the
+records to be deleted (i.e. a comma-separated list of user names), into a
+`Textarea`.
+-}
 module Handler.Utils.Delete
  ( DeleteRoute(..)
  , deleteR