Add a test for WARNINGS.md #660
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
laurentlb
approved these changes
Jul 12, 2019
warn/documentation_test.go
Outdated
| for _, warning := range AllWarnings { | ||
| link := fmt.Sprintf(" * [%s](#%s)", warning, warning) | ||
| if !strings.Contains(contents, link) { | ||
| t.Errorf("No link found for the warning %q in WARNINGS.md, is it documented?", warning) |
There was a problem hiding this comment.
nit. the error message should include the pattern you match (link).
warn/documentation_test.go
Outdated
|
|
||
| anchor := fmt.Sprintf(`<a name="%s"></a>`, warning) | ||
| if !strings.Contains(contents, anchor) { | ||
| t.Errorf("No anchor found for the warning %q in WARNINGS.md, is it documented?", warning) |
cristiancreteanu
pushed a commit
to cristiancreteanu/buildtools
that referenced
this pull request
Aug 30, 2019
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.
All warnings contain a link to
https://github.com/bazelbuild/buildtools/blob/master/WARNINGS.md#<category_name>, the new test ensures that all registered warnings are documented in the file (at least that there's a link in the header and an anchor for each warning).