Add top-level documentation to Haddocks

pgujjula · May 20, 2024 · bec52f6 · bec52f6
1 parent d0b5faf
commit bec52f6
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/src/Data/List/ApplyMerge.hs b/src/Data/List/ApplyMerge.hs
@@ -7,8 +7,12 @@
 -- License: BSD-3-Clause
 -- Maintainer: Preetham Gujjula <[email protected]>
 -- Stability: experimental
+--
+-- Lift a binary, non-decreasing function onto ordered lists and order the
+-- output.
 module Data.List.ApplyMerge
-  ( applyMerge,
+  ( -- * Functions
+    applyMerge,
     applyMergeBy,
     applyMergeOn,
 

diff --git a/src/Data/List/NonEmpty/ApplyMerge.hs b/src/Data/List/NonEmpty/ApplyMerge.hs
@@ -7,6 +7,8 @@
 -- License: BSD-3-Clause
 -- Maintainer: Preetham Gujjula <[email protected]>
 -- Stability: experimental
+--
+-- Like "Data.List.ApplyMerge", but for 'NonEmpty' instead of lists.
 module Data.List.NonEmpty.ApplyMerge
   ( applyMerge,
     applyMergeBy,