From ee9bc2bbed4ed004b917d3a3ef63bf8853bf2542 Mon Sep 17 00:00:00 2001
From: Chris Done <chrisdone@gmail.com>
Date: Sun, 4 Jan 2015 20:49:14 +0100
Subject: [PATCH] Document Stackage.CheckBuildPlan

---
 Stackage/CheckBuildPlan.hs | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/Stackage/CheckBuildPlan.hs b/Stackage/CheckBuildPlan.hs
index 1ad76b27..f13265aa 100644
--- a/Stackage/CheckBuildPlan.hs
+++ b/Stackage/CheckBuildPlan.hs
@@ -19,6 +19,7 @@ import           Stackage.Prelude
 -- FIXME check cycles in dependencies, only looking at libraries and
 -- executables
 
+-- | Check the build plan for missing deps, wrong versions, etc.
 checkBuildPlan :: MonadThrow m => BuildPlan -> m ()
 checkBuildPlan BuildPlan {..}
     | null errs' = return ()
@@ -28,6 +29,10 @@ checkBuildPlan BuildPlan {..}
     errs@(BadBuildPlan errs') =
         execWriter $ mapM_ (checkDeps allPackages) $ mapToList bpPackages
 
+-- | For a given package name and plan, check that its dependencies are:
+--
+-- 1. Existent (existing in the provided package map)
+-- 2. Within version range
 checkDeps :: Map PackageName Version
           -> (PackageName, PackagePlan)
           -> Writer BadBuildPlan ()