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

Severity Documentation #139

Open
Noggog opened this issue Sep 27, 2024 · 0 comments
Open

Severity Documentation #139

Noggog opened this issue Sep 27, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@Noggog
Copy link
Member

Noggog commented Sep 27, 2024

In Mutagen's analyzers I thought of it like this:

  • Critical/CTD: Absolute fundamental problem that crashes or freezes the game
  • Error: Something's going to be wrong, has a known negative side effect, but still playable. Missing textures, etc
  • Warning: Something's odd or wrong, but doesn't have any known negative side effects. Might be upgraded to error if one was discovered
  • Suggestion: Optimizations, small improvements or other suggestions.

warnings might be stuff like:

  • Unknown record type. Odd. Might cause issues. Unsure. I wouldn't necessarily call it a suggestion, as that indicates we have a recommended action to do.. when we really dont. It's just weird. So just a warning
  • Unknown value in an Enum. Again, odd, not yet sure if it's causing any problems, but not necessarily something i'd call a suggestion

Suggestions currently have stuff like:

  • Conditions can be simplified. Not a warning. Not causing bugs. But we suggest improving it
  • New but deleted records. Someone made an item then deleted it. Just fluff. Not really a "warning", per se, but we can suggest just removing the totally unused thing

Also would be good to document how to recommend a topic's level be changed

@Noggog Noggog added the documentation Improvements or additions to documentation label Sep 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant