From 9e3f65b925edb800225b9eabe61f39acfba4e1ef Mon Sep 17 00:00:00 2001 From: Luc Tielen Date: Sun, 14 Aug 2022 15:11:07 +0200 Subject: [PATCH] Add docs to Warn and Err patterns --- src/Error/Diagnose/Report/Internal.hs | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/src/Error/Diagnose/Report/Internal.hs b/src/Error/Diagnose/Report/Internal.hs index a6bd7ed..dda4017 100644 --- a/src/Error/Diagnose/Report/Internal.hs +++ b/src/Error/Diagnose/Report/Internal.hs @@ -75,9 +75,14 @@ data Report msg [Note msg] -- ^ A list of notes to add at the end of the report. -pattern Warn, Err :: Maybe msg -> msg -> [(Position, Marker msg)] -> [Note msg] -> Report msg +-- | Pattern synonym for a warning report. +pattern Warn :: Maybe msg -> msg -> [(Position, Marker msg)] -> [Note msg] -> Report msg pattern Warn errCode msg reports notes = Report False errCode msg reports notes + +-- | Pattern synonym for an error report. +pattern Err :: Maybe msg -> msg -> [(Position, Marker msg)] -> [Note msg] -> Report msg pattern Err errCode msg reports notes = Report True errCode msg reports notes + {-# COMPLETE Warn, Err #-} instance Semigroup msg => Semigroup (Report msg) where