Mesabloo/diagnose
1
1
Fork 0
mirror of https://github.com/Mesabloo/diagnose.git synced 2024-11-22 17:52:15 +03:00
Code Issues Projects Releases Wiki Activity

fix main documentation

Browse Source
This commit is contained in:
Mesabloo 2022-05-03 17:35:37 +02:00
parent 75816d465c
commit bb0028ff1c
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/Error/Diagnose.hs
View File

@ -13,7 +13,7 @@ module Error.Diagnose
-- *** Pretty-printing a diagnostic onto a file 'System.IO.Handle' -- *** Pretty-printing a diagnostic onto a file 'System.IO.Handle'
-- $diagnostic_pretty -- $diagnostic_pretty
-- *** Pretty-printing a diagnostic as a 'PrettyPrinter.Doc'ument -- *** Pretty-printing a diagnostic as a document
-- $diagnostic_to_doc -- $diagnostic_to_doc
-- *** Exporting a diagnostic to JSON -- *** Exporting a diagnostic to JSON
@ -164,9 +164,12 @@ import Error.Diagnose.Style as Export
-- $diagnostic_to_doc -- $diagnostic_to_doc
-- --
-- 'Diagnostic's can be “output” (at least ready to be rendered) to a 'Prettyprinter.Doc', which allows it to be easily added to other 'Prettyprinter.Doc' outputs. -- 'Diagnostic's can be “output” (at least ready to be rendered) to a 'Prettyprinter.Doc' using 'prettyDiagnostic', which allows it to be easily added to other 'Prettyprinter.Doc' outputs.
-- This makes it easy to customize the error messages further (though not the internal parts, only adding to it). -- This makes it easy to customize the error messages further (though not the internal parts, only adding to it).
-- As a 'Prettyprinter.Doc', there is also the possibility of altering internal annotations (styles) much easier (although this is already possible when printing the diagnostic). -- As a 'Prettyprinter.Doc', there is also the possibility of altering internal annotations (styles) much easier (although this is already possible when printing the diagnostic).
--
-- The arguments of the function mostly follow the ones from 'printDiagnostic'.
-- The style is not one, as it can be applied by simply applying the styling function to the resulting function (if wanted).
-- $diagnostic_json -- $diagnostic_json
-- --