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

Theme: good error messages #5

Open
6 tasks
AustinWise opened this issue Jan 11, 2022 · 0 comments
Open
6 tasks

Theme: good error messages #5

AustinWise opened this issue Jan 11, 2022 · 0 comments
Labels
theme A desired property of the software; groups other issues

Comments

@AustinWise
Copy link
Owner

When an error happens, it should be clear what the cause was and how the user can fix the problem. This includes both command ling error messages and error messages sent over HTTP.

  • Error messages sent of HTTP should ideally look relatively nice. Like they should not be plain text; they should not be the output from a Debug trait impl.
  • Do we have to worry about that thing where IE only displays error pages greater than 512 bytes in size? It looks like Chrome may have copied this feature
  • Audit the different From implementations for MyError. Make sure the message matches the level of specificity of the error type they convert from.

Some specific cases that are known to not have good error messages:

  • When a markdown file is not valid UTF-8.
  • Failures to read wiki pages.
  • Failure to find wiki pages.
@AustinWise AustinWise added the theme A desired property of the software; groups other issues label Jan 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
theme A desired property of the software; groups other issues
Projects
None yet
Development

No branches or pull requests

1 participant