Simplify error code naming system #33
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Currently, the error code class for a given check has to have an arbitrary name which must start with "Error", but cannot be "ErrorCode" or "Error". Given that the name of the error class is not used/displayed anywhere, and doesn't provide any extra context, having to give them a name (similar to the filename) doesn't make a lot of sense. I've updated all checks to be called "ErrorInfo", making all the checks more consistent (similar to the name of the "check" functions). At some point I might make it required for these error info classes to be named "ErrorInfo", but that would be a breaking change. If we do want to "name" the checks, an explicit "name" field in the class would be a better option, and better then relying on the classname. As an aside, there should probably be warnings that go off if you have a check function or error class which is not the right type, or for whatever reason, your check cannot be loaded.
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Currently, the error code class for a given check has to have an arbitrary name which must start with "Error", but cannot be "ErrorCode" or "Error". Given that the name of the error class is not used/displayed anywhere, and doesn't provide any extra context, having to give them a name (similar to the filename) doesn't make a lot of sense. I've updated all checks to be called "ErrorInfo", making all the checks more consistent (similar to the name of the "check" functions). At some point I might make it required for these error info classes to be named "ErrorInfo", but that would be a breaking change.
If we do want to "name" the checks, an explicit "name" field in the class would be a better option, and better then relying on the classname.
As an aside, there should probably be warnings that go off if you have a check function or error class which is not the right type, or for whatever reason, your check cannot be loaded.