[commit: ghc] master: Documentation for FrontendResult (59883ae)

[git at git.haskell.org]

Repository : ssh://git@git.haskell.org/ghc

On branch  : master
Link       : http://ghc.haskell.org/trac/ghc/changeset/59883ae370b50f7b59a9bc57b76291fc31937967/ghc

>---------------------------------------------------------------

commit 59883ae370b50f7b59a9bc57b76291fc31937967
Author: Edward Z. Yang <ezyang at cs.stanford.edu>
Date:   Tue Oct 6 10:14:39 2015 -0700

    Documentation for FrontendResult
    
    Signed-off-by: Edward Z. Yang <ezyang at cs.stanford.edu>


>---------------------------------------------------------------

59883ae370b50f7b59a9bc57b76291fc31937967
 compiler/typecheck/TcRnTypes.hs | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/compiler/typecheck/TcRnTypes.hs b/compiler/typecheck/TcRnTypes.hs
index 7f51c33..b5da234 100644
--- a/compiler/typecheck/TcRnTypes.hs
+++ b/compiler/typecheck/TcRnTypes.hs
@@ -329,6 +329,14 @@ data DsMetaVal
 ************************************************************************
 -}
 
+-- | 'FrontendResult' describes the result of running the
+-- frontend of a Haskell module.  Usually, you'll get
+-- a 'FrontendTypecheck', since running the frontend involves
+-- typechecking a program, but for an hs-boot merge you'll
+-- just get a ModIface, since no actual typechecking occurred.
+--
+-- This data type really should be in HscTypes, but it needs
+-- to have a TcGblEnv which is only defined here.
 data FrontendResult
         = FrontendTypecheck TcGblEnv
         | FrontendMerge     ModIface