Skip to content
GitLab
  • Menu
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
  • sac2c sac2c
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 394
    • Issues 394
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 16
    • Merge requests 16
  • Deployments
    • Deployments
    • Releases
  • Wiki
    • Wiki
  • External wiki
    • External wiki
  • Activity
  • Graph
  • Create a new issue
  • Commits
  • Issue Boards
Collapse sidebar
  • sac-group
  • sac2csac2c
  • Wiki
  • Error messages
  • Good error messages

Good error messages · Changes

Page history
Introduced directories into the wiki and added content based on my talk with... authored Feb 07, 2025 by Quinten Cabo's avatar Quinten Cabo
Introduced directories into the wiki and added content based on my talk with Bodo and my own thoughts
Hide whitespace changes
Inline Side-by-side
error-messages/Good-error-messages.md 0 → 100644
View page @ de8600b9
In this fire we list properties of good error messages along with (if you have it) some proof as to why it is a good property.
From [On Compiler Error Messages: What They _Say_ and What They _Mean_](https://onlinelibrary.wiley.com/doi/10.1155/2010/602570)
- Say not only what the problem is but why it is there
- Say how you can potentially solve the error
- Link to docs about concepts that need to be further explained to keep error messages short
- Don't blame the programmer
- Are positive
- use colors and stay consistent
- avoid reference to compiler internals
From [Towards Assessing the Readability of Programming Error Messages](https://dl.acm.org/doi/fullHtml/10.1145/3441636.3442320)
- Do not have too much jargon back to back, and link to explanations of the jargon used
- Are not too long
- Give relevant information
Sijmen:
- Comes from the perspective of the user not the perspective of the compiler
- Are friendly
- assist you
Clone repository
  • concepts
    • Deprecated Modules
    • Globals
    • Named Tuples
    • Overloading
    • Preprocessor
    • Primitive functions
    • Runetime Representations
    • input stdin
    • phm xt
    • ref counting methods
    • type famlies
    • type patterns
  • error messages
    • Anthropomorphic error essages
    • Colored error messages
    • Empty file error
View All Pages