docs: tighten the clang-tidy and make lint prose - #65
Merged
Conversation
Comment and prose wording only; no functional change. Names HeaderFilterRegex explicitly in .clang-tidy, and states the make lint failure condition as a sentence rather than a clause.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Prose only. No functional change.
Two wording changes that arrived after the files they touch had already merged (#60 and #61), so they
had nowhere to land at the time. Parked rather than padded onto the diffs of #62, #63, and #64, which
were about unrelated things.
.clang-tidy— namesHeaderFilterRegexexplicitly instead of "a project-relative anchor", andsays "excludes every project header" rather than "matches no headers and drops their diagnostics".
README.md— "every enabled check is an error" becomes "Any reported finding fails the target",as its own sentence.
Verification
.clang-tidy: no non-comment lines changed;HeaderFilterRegex: '.*'untouchedREADME.md: the rewrap is prettier-canonical, soprettier --checkis satisfiedmake format-checkandmake lintboth exit 0