Improve warning message for missing includes #113
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.
Related issues
Closes #50.
I adopted a slightly different solution than that outlined in #50, after offline discussion with @laserkelvin. Rather than print a large number of suggested actions as part of each individual warning message, we can use a meta-warning to describe suggested fixes just once.
Proposed changes
A quick example of what this looks like:
Writing "user" or "system" in the message is mainly there to help us build a
WarningAggregator
that can give different advice in both cases, but it should also be helpful for anybodygrep
ing through the logs.