Show brief after rule ID in verbose text output #132
Merged
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.
The rule brief is a short description of the rule. When arduino-lint is run in
--verbose
mode, the ID of each rule isdisplayed. While this serves to show the progress of linting each project, the user will not know the significance of
these IDs, and previously wouldn't get any other context unless the rule was violated (in which case the failure message
is displayed), so it is somewhat cryptic.
Displaying the brief after the rule ID explains the rules that are being run without increasing the volume of output significantly.
Before:
After:
Note: The wording of the rule briefs will be improved by #130 (d4c5e9c) to be more suitable for this application, but those improvements won't take effect until #130 is merged. This PR only implements the mechanics of displaying the rule brief text.