diff options
author | Joris | 2016-03-19 11:58:38 +0100 |
---|---|---|
committer | Joris | 2016-03-19 11:58:38 +0100 |
commit | 3e5d3d47c90194403967e11994ea559b00b0f8ef (patch) | |
tree | 1a374a3668ce1760494c016d744e399f1b584173 /Data | |
parent | bf804f73ce3494be430054499c5ce18f232f68ca (diff) |
Update documentation
Diffstat (limited to 'Data')
-rw-r--r-- | Data/ConfigManager.hs | 6 | ||||
-rw-r--r-- | Data/ConfigManager/Types.hs | 2 | ||||
-rw-r--r-- | Data/ConfigManager/Types/Internal.hs | 10 |
3 files changed, 9 insertions, 9 deletions
diff --git a/Data/ConfigManager.hs b/Data/ConfigManager.hs index bd62f40..00968f5 100644 --- a/Data/ConfigManager.hs +++ b/Data/ConfigManager.hs @@ -65,7 +65,7 @@ lookupDefault defaultValue name config = M.lookupDefault defaultValue name (hash -- $bindings -- --- A binding associates a name to a value. +-- A binding associates a name to a value: -- -- > number = 1 -- > my-string = "Hello" @@ -82,9 +82,9 @@ lookupDefault defaultValue name config = M.lookupDefault defaultValue name (hash -- > import "database.conf" -- > importMaybe "local.conf" --- $comment +-- $comments -- --- A comment begins with '#' and continues to the end of the line. +-- A comment begins with '#' and continues to the end of the line: -- -- > # Comment -- > x = 8 # Another comment diff --git a/Data/ConfigManager/Types.hs b/Data/ConfigManager/Types.hs index ddc578f..ea2691f 100644 --- a/Data/ConfigManager/Types.hs +++ b/Data/ConfigManager/Types.hs @@ -4,7 +4,7 @@ -- Maintainer: Joris Guyonvarch <joris@guyonvarch.me> -- Stability: experimental -- --- Types for working with configuration files. +-- Configuration management types. module Data.ConfigManager.Types ( Config(..) diff --git a/Data/ConfigManager/Types/Internal.hs b/Data/ConfigManager/Types/Internal.hs index 5b91802..c4d5d0e 100644 --- a/Data/ConfigManager/Types/Internal.hs +++ b/Data/ConfigManager/Types/Internal.hs @@ -10,28 +10,28 @@ import Data.Text (Text) import Data.HashMap.Strict --- | Configuration data +-- | Configuration data. data Config = Config { hashMap :: HashMap Name Value } deriving (Eq, Read, Show) --- | An expression is either a binding or an import +-- | An expression is either a binding or an import. data Expr = Binding Name Value | Import Requirement FilePath deriving (Eq, Read, Show) --- | A name is a text +-- | A name is a text. type Name = Text --- | A value is a text +-- | A value is a text. type Value = Text --- | A requirement is either required or optional +-- | A requirement is either required or optional. data Requirement = Required |