Config module description
commitc9f3d872dc6d6a587c431765ffcd7a5099e0891b
authorGreg Weber <greg@gregweber.info>
dateSun 14 Feb 2016, 21:54 (11 years ago)
parent4ae72c0
Data/Yaml/Config.hs+8−1
@@ -1,6 +1,13 @@
11{-# LANGUAGE CPP #-}
22{-# LANGUAGE OverloadedStrings #-}
3−-- | Some next-gen helper functions for the scaffolding's configuration system.
3+-- | Functionality for using YAML as configuration files
4+--
5+-- In particular, merging environment variables with yaml values
6+--
7+-- 'loadYamlSettings' is a high-level API for loading YAML and merging environment variables.
8+-- A yaml value of @_env:ENV_VAR:default@ will lookup the environment variable @ENV_VAR@.
9+--
10+-- On a historical note, this code was taken directly from the yesod web framework's configuration module.
411module Data.Yaml.Config
512 ( applyCurrentEnv
613 , getCurrentEnv