Merge pull request #146 from haskell-hint/issue-145/typeChecks-doc-bug

fix typeChecks documentation
haskell-hint · Mar 6, 2022 · 090ee37 · 090ee37
2 parents 77a7211 + 0bd9841
commit 090ee37
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/src/Hint/Typecheck.hs b/src/Hint/Typecheck.hs
@@ -23,8 +23,8 @@ typeOf expr =
 
 -- | Tests if the expression type checks.
 --
--- NB. Be careful if there is `-fdefer-type-errors` involved.
--- Perhaps unsurprisingly, that can falsely make @typeChecks@ and @getType@
+-- NB. Be careful if @unsafeSetGhcOption "-fdefer-type-errors"@ is used.
+-- Perhaps unsurprisingly, that can falsely make @typeChecks@ and @typeChecksWithDetails@
 -- return @True@ and @Right _@ respectively.
 typeChecks :: MonadInterpreter m => String -> m Bool
 typeChecks expr = (True <$ typeOf expr)