diagnose-1.6.3: src/Error/Diagnose/Compat/Hints.hs

{-# LANGUAGE MultiParamTypeClasses #-}

module Error.Diagnose.Compat.Hints where
    
-- | A class mapping custom errors of type @e@ with messages of type @msg@.
class HasHints e msg where
  -- | Defines all the hints associated with a given custom error.
  hints :: e -> [msg]

-- this is a sane default for 'Void'
-- but this can be redefined
--
-- instance HasHints Void msg where
--   hints _ = mempty