Merge pull request #36 from reflex-frp/improve-doc

Improve module headers

Author: Ericson2314

src/Data/Functor/Misc.hs

@@ -10,9 +10,14 @@
 {-# LANGUAGE RankNTypes #-}
 {-# LANGUAGE ScopedTypeVariables #-}
 {-# LANGUAGE StandaloneDeriving #-}
--- | This module provides types and functions with no particular theme, but
--- which are relevant to the use of 'Functor'-based datastructures like
--- 'Data.Dependent.Map.DMap'.
+
+{- |
+Description: Misc utilities relating to functor.
+
+This module provides types and functions with no particular theme, but which
+are relevant to the use of 'Functor'-based datastructures like
+'Data.Dependent.Map.DMap'.
+-}
 module Data.Functor.Misc
   ( -- * Const2
     Const2 (..)

src/Data/Monoid/DecidablyEmpty.hs

@@ -5,6 +5,9 @@
 {-# LANGUAGE TypeOperators #-}
 
 -- TODO upstream somwhere else?
+{-|
+Description: This module provides a class to decide whether a monoid element is the identity.
+-}
 module Data.Monoid.DecidablyEmpty where
 
 import Data.Functor.Identity

src/Data/Patch.hs

@@ -3,11 +3,11 @@
 {-# LANGUAGE StandaloneDeriving #-}
 {-# LANGUAGE TypeFamilies #-}
 {-# LANGUAGE TypeOperators #-}
--- |
--- Module:
---   Data.Patch
--- Description:
---   This module defines the 'Patch' class.
+
+{-|
+Description:
+  This module defines the 'Group' class, and reexports the other modules.
+-}
 module Data.Patch
   ( module Data.Patch
   , module X

src/Data/Patch/Class.hs

@@ -1,7 +1,12 @@
 {-# LANGUAGE CPP #-}
 {-# LANGUAGE ScopedTypeVariables #-}
 {-# LANGUAGE TypeFamilies #-}
--- | The interface for types which represent changes made to other types
+
+{-|
+Description: The module provides the 'Patch' class.
+
+This is a class for types which represent changes made to other types
+-}
 module Data.Patch.Class where
 
 import Data.Functor.Identity

src/Data/Patch/DMap.hs

@@ -7,7 +7,12 @@
 {-# LANGUAGE StandaloneDeriving #-}
 {-# LANGUAGE TypeFamilies #-}
 
--- | 'Patch'es on 'DMap' that consist only of insertions (or overwrites) and deletions.
+{-|
+Description: A basic 'Patch' on 'DMap'
+
+Patches of this type consist only of insertions (including overwrites) and
+deletions.
+-}
 module Data.Patch.DMap where
 
 import Data.Patch.Class

src/Data/Patch/DMapWithMove.hs

@@ -11,8 +11,13 @@
 {-# LANGUAGE TypeFamilies #-}
 {-# LANGUAGE UndecidableInstances #-}
 
--- |Module containing @'PatchDMapWithMove' k v@ and associated functions, which represents a 'Patch' to a @'DMap' k v@ which can insert, update, delete, and
--- move values between keys.
+{-|
+Description: A more advanced 'Patch' for 'DMap'.
+
+This Module contains @'PatchDMapWithMove' k v@ and associated functions, which
+represents a 'Patch' to a @'DMap' k v@ which can insert, update, delete, and
+move values between keys.
+-}
 module Data.Patch.DMapWithMove where
 
 import Data.Patch.Class

src/Data/Patch/IntMap.hs

@@ -7,8 +7,11 @@
 {-# LANGUAGE TemplateHaskell #-}
 {-# LANGUAGE TypeFamilies #-}
 
--- | Module containing 'PatchIntMap', a 'Patch' for 'IntMap' which allows for
--- insert/update or delete of associations.
+{-|
+Description: Module containing 'PatchIntMap', a 'Patch' for 'IntMap'.
+
+Patches of this sort allow for insert/update or delete of associations.
+-}
 module Data.Patch.IntMap where
 
 import Control.Lens

src/Data/Patch/Map.hs

@@ -8,8 +8,12 @@
 {-# LANGUAGE TemplateHaskell #-}
 {-# LANGUAGE TypeFamilies #-}
 
--- | 'Patch'es on 'Map' that consist only of insertions (including overwrites)
--- and deletions
+{-|
+Description: A basic 'Patch' on 'Map'
+
+Patches of this type consist only of insertions (including overwrites) and
+deletions.
+-}
 module Data.Patch.Map where
 
 import Data.Patch.Class

src/Data/Patch/MapWithMove.hs

@@ -14,8 +14,12 @@
 {-# LANGUAGE TypeFamilies #-}
 {-# LANGUAGE ViewPatterns #-}
 
--- | 'Patch'es on 'Map' that can insert, delete, and move values from one key to
--- another
+{-|
+Description: An intermediate 'Patch' on 'Map'
+
+Patches of this type can insert, delete, and also move values from one key to
+another.
+-}
 module Data.Patch.MapWithMove
   ( PatchMapWithMove
     ( PatchMapWithMove

src/Data/Patch/MapWithPatchingMove.hs

@@ -11,8 +11,12 @@
 {-# LANGUAGE TypeFamilies #-}
 {-# LANGUAGE UndecidableInstances #-}
 
--- | 'Patch'es on 'Map' that can insert, delete, and move values from one key to
--- another
+{-|
+Description: An advanced 'Patch' on 'Map'
+
+Patches of this type can can insert, delete, and move values from one key to
+another, and move patches may also additionally patch the value being moved.
+-}
 module Data.Patch.MapWithPatchingMove
   ( PatchMapWithPatchingMove (..)
   , patchMapWithPatchingMove