adding doc to findCradle.

2013-09-20 15:53:51 +09:00 · 2013-09-20 15:53:51 +09:00 · 39bccf8b92
commit 39bccf8b92
parent 49791fb6ea
1 changed files with 3 additions and 0 deletions
--- a/Language/Haskell/GhcMod/Cradle.hs
+++ b/Language/Haskell/GhcMod/Cradle.hs
@ -12,6 +12,9 @@ import System.FilePath ((</>),takeDirectory)
 ----------------------------------------------------------------

 -- | Finding 'Cradle'.
+--   Find a cabal file by tracing ancestor directories.
+--   Find a sandbox according to a cabal sandbox config
+--   in a cabal directory.
 findCradle :: IO Cradle
 findCradle = do
    wdir <- getCurrentDirectory