summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEdward Z. Yang <ezyang@cs.stanford.edu>2015-10-06 10:14:39 -0700
committerEdward Z. Yang <ezyang@cs.stanford.edu>2015-10-06 10:17:44 -0700
commit59883ae370b50f7b59a9bc57b76291fc31937967 (patch)
tree4a63af5b52488bee9a2ee224307988e3bcbdb1ca
parent3833e71dba10b0a347b5a297a75dcdb6c69d7e72 (diff)
downloadhaskell-59883ae370b50f7b59a9bc57b76291fc31937967.tar.gz
Documentation for FrontendResult
Signed-off-by: Edward Z. Yang <ezyang@cs.stanford.edu>
-rw-r--r--compiler/typecheck/TcRnTypes.hs8
1 files changed, 8 insertions, 0 deletions
diff --git a/compiler/typecheck/TcRnTypes.hs b/compiler/typecheck/TcRnTypes.hs
index 7f51c332da..b5da234818 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