Improve handling of check output #89
Merged
Conversation
This file contains hidden or 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
The check functions may output an explanation when they are unable to run, which is printed to the console following a "notice:" check result label. If no explanation was provided by the check function author, this resulted in a confusing line in the console. Although it is best for an explanation to always be provided, this is not guaranteed to always be done, so it's more user friendly to suppress the check level display in this situation.
Previously, the level returned was for a failure result, regardless of the actual result of the check, with the effective check level adjusted according to the check result in the result package. The code is more maintainable and easier to understand if the check level is determined in a single location. The checklevel package is the logical place for that.
Previously, the message in the report was always that of the failure state of the check, regardless of the actual check result.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in 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.
Check functions may return a string that provides information about the check result.
Previously, the focus was primarily on the handling of output in the case of a failure check result, but the output can be useful to provide an explanation to the user about why the check couldn't be or wasn't run and the handling of this functionality was very poor.