Skip to content

Commit

Permalink
Explain the purpose of Liquid.GHC.API
Browse files Browse the repository at this point in the history
  • Loading branch information
facundominguez committed Sep 19, 2023
1 parent a9a43d5 commit 322baed
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions liquidhaskell-boot/src-ghc/Liquid/GHC/API.hs
Original file line number Diff line number Diff line change
@@ -1,9 +1,14 @@
{-| This module re-exports a bunch of the GHC API.
{-| This module re-exports all identifiers that LH needs
from the GHC API.
The intended use of this module is to shelter LiquidHaskell from changes to the GHC API, so this is the
/only/ module LiquidHaskell should import when trying to access any ghc-specific functionality.
The intended use of this module is to provide a quick look of what
GHC API features LH depends upon.
--}
The transitive dependencies of this module shouldn't contain modules
from Language.Haskell.Liquid.* or other non-boot libraries. This makes
it easy to discover breaking changes in the GHC API.
-}

{-# LANGUAGE DeriveTraversable #-}
{-# LANGUAGE LambdaCase #-}
Expand Down

0 comments on commit 322baed

Please sign in to comment.