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

Document known non-exceptional errors #2621

Open
corrideat opened this issue Feb 12, 2025 · 0 comments
Open

Document known non-exceptional errors #2621

corrideat opened this issue Feb 12, 2025 · 0 comments
Labels
Kind:Core Anything that changes or affects the fundamental core data structures & design of the application. Kind:Documentation

Comments

@corrideat
Copy link
Member

Problem

Sometimes, error conditions happen that, despite looking like errors or being logged like errors, are, in fact, expected to happen, or least not severe. One such example is that a decryption error generally isn't treated like a fatal condition.

Solution

Document all known instances of this as they become known, including:

  1. A brief description of the error
  2. Why it happens
  3. Why it's not really an error
  4. If applicable, under which situations it would be an error
@taoeffect taoeffect added Kind:Documentation Kind:Core Anything that changes or affects the fundamental core data structures & design of the application. labels Feb 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Kind:Core Anything that changes or affects the fundamental core data structures & design of the application. Kind:Documentation
Projects
None yet
Development

No branches or pull requests

2 participants