Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add list with explanations of editor messages #281

Open
4 tasks
MeAmAnUsername opened this issue Apr 7, 2022 · 0 comments
Open
4 tasks

Add list with explanations of editor messages #281

MeAmAnUsername opened this issue Apr 7, 2022 · 0 comments

Comments

@MeAmAnUsername
Copy link
Owner

Summary
Add a list with explanations for errors, warnings and notes to the documentation

Todo

  • Get list of all errors, warnings and notes
  • Consolidate/merge messages where practical
  • Create file, add to TOC
  • Write list

Reason
While most errors, warnings and notes should be self explanatory, they often do not exhaustively explain everything, so it would be nice to have such an explanation in the documentation

Description
Messages can be consolidated/merged when practical. I expect that many Type mismatch messages can be merged.
Each message should explain what it means, the cause, and how to solve it.
Also explain what BUG: and BUG?: messages mean: a fundamental assumption of the DSL static semantics spec turns out to not be true, so it is (or for BUG?, might be) a bug in the spec. Please file a bug report.

Related issues
None

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant