Add more code comments.

[dead/htsn.git] / src / Configuration.hs

diff --git a/src/Configuration.hs b/src/Configuration.hs
index 71dbbc9e4c83310bac66a53152473a8be0e57d27..7b237c5f1d0d350de28b8d00bc711fabcc78ee2c 100644 (file)
--- a/src/Configuration.hs
+++ b/src/Configuration.hs
@@ -1,7 +1,7 @@
 -- | This module defines the 'Configuration' type, which is just a
 --   wrapper around all of the configuration options we accept on the
---   command line. We thread this throughout the rest of the program.
-
+--   command line.
+--
 module Configuration (
   Configuration(..),
   merge_optional )
@@ -25,6 +25,10 @@ data Configuration =
 instance Default Configuration where
   def = Configuration def def "." def
 
+
+-- | Merge a Configuration with an OptionalConfiguration. This is more
+--   or less the Monoid instance for OptionalConfiguration, but since
+--   the two types are different, we have to repeat ourselves.
 merge_optional :: Configuration
                -> OC.OptionalConfiguration
                -> Configuration