search

mbarbin / error-log

Reporting located errors and warnings
https://mbarbin.github.io/error-log/
MIT License
1 stars 0 forks source link

readme

error-log

CI Status Coverage Status

Error_log is a library for programs that process user programs and report located errors and warnings (compilers, interpreters, etc.)

The canonical syntax for an error produced by this lib is:

File "my-file", line 42, character 11-15:
Error: Some message that gives a general explanation of the issue.
Followed by more details, perhaps some sexps, etc.
((A sexp)(with more)(details)
  (such_as
   (extra_values)))

It is inspired by dune's user_messages and uses dune's error message rendering under the hood.

Code documentation

The code documentation of the latest release is built with odoc and published to GitHub pages here.