Add a little documentation

byg/src/Byg/DependencyGenerator.hs

@@ -1,5 +1,8 @@
 {-# LANGUAGE GADTs #-}
 {-# LANGUAGE FunctionalDependencies #-}
+
+-- | Combinators for generating a list of dependencies between calculations, to
+-- be executed later in DependencyRunner.
 module Byg.DependencyGenerator
   ( DepGenM
   , DepGenM'

byg/src/Byg/DependencyRunner.hs

@@ -1,4 +1,11 @@
 {-# LANGUAGE MonoLocalBinds #-}
+
+-- | Run the actual operations from the generated dependencies from DependencyGenerator.
+--
+-- This does not work fully as intended right now (computes more than strictly
+-- needed) and needs to be rewritten in a more testable way. The idea is to only
+-- evaluate something if a future operation depends on it, which is reflected in
+-- the ValueExistence type.
 module Byg.DependencyRunner
   ( DepRunM
   , runDeps

byg/src/Byg/Functions.hs

@@ -1,3 +1,4 @@
+-- | All byg functions.
 module Byg.Functions
   ( module Byg.Functions.Image
   , module Byg.Functions.Pandoc

byg/src/Byg/Types.hs

@@ -1,13 +1,14 @@
+-- | All byg types.
 module Byg.Types
   ( module Byg.Types.Token
   , module Byg.Types.Value
   , module Byg.Types.Functions
   , module Byg.Types.Date
-  , Dependency
+  , module Byg.Types.Dependency
   ) where
 
 import Byg.Types.Token
 import Byg.Types.Value
 import Byg.Types.Functions
 import Byg.Types.Date
-import Byg.Types.Dependency (Dependency)
+import Byg.Types.Dependency

byg/src/Byg/Types/Date.hs

@@ -1,3 +1,4 @@
+-- | Date functions.
 module Byg.Types.Date
   ( Date(..)
   , formatDate

byg/src/Byg/Types/Dependency.hs

@@ -1,4 +1,6 @@
 {-# LANGUAGE GADTs #-}
+
+-- | Keeps track of the graph of calculation dependencies.
 module Byg.Types.Dependency
   ( Action(..)
   , F(..)

byg/src/Byg/Types/Functions.hs

@@ -1,4 +1,6 @@
 {-# LANGUAGE FunctionalDependencies #-}
+
+-- | Calculation function types.
 module Byg.Types.Functions
   ( IsFunctionIO(..)
   ) where

byg/src/Byg/Types/Token.hs

@@ -1,4 +1,6 @@
 {-# LANGUAGE GADTs #-}
+
+-- | Tokens represent future values.
 module Byg.Types.Token
   ( Token(..)
   ) where

byg/src/Byg/Types/Value.hs

@@ -1,4 +1,6 @@
 {-# LANGUAGE MonoLocalBinds #-}
+
+-- | Small wrapper over the Dynamic type.
 module Byg.Types.Value
   ( Value(..)
   , toValue