-
Notifications
You must be signed in to change notification settings - Fork 200
Design Goals
Marc Scholten edited this page Aug 16, 2020
·
1 revision
IHP error messages should be clear, actionable and practical. A great error messages clearly tells the user what went wrong and what the user needs to do to fix the problem. It should direct the user to the solution most likely needed.
In case the error messages are produced by GHC, we should use troubleshooting helpers in the StatusServer to show actionable steps for a solution. In case a Haskell exception is thrown at runtime, we can use the ErrorController to explain the error message in the IHP context.
Here are some examples of improved error messages.
Unclear error message:
AutoRoute: Failed parsing UUID
AutoRoute: Failed parsing argument as UUID. You most likely are trying to use AutoRoute with a non-UUID attribute. See https://ihp.digitallyinduced.com/Guide/routing.html#parameter-types for details on how to configure this.