Correct maxIssues documentation#3456
Merged
Merged
Conversation
Codecov Report
@@ Coverage Diff @@
## master #3456 +/- ##
=========================================
Coverage 80.26% 80.26%
Complexity 2785 2785
=========================================
Files 454 454
Lines 8418 8418
Branches 1609 1609
=========================================
Hits 6757 6757
Misses 789 789
Partials 872 872 Continue to review full report at Codecov.
|
picklebento
approved these changes
Feb 8, 2021
picklebento
left a comment
picklebento
left a comment
Member
There was a problem hiding this comment.
Lately, we updated the CLI args https://detekt.github.io/detekt/cli.html and I verified the language there is accurate. Thank you for improving the accuracy of our documentation!
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
4 participants
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.
This repo's own config contains
maxIssues: 0, which only makes sense under this PR's new wording since it'd be impossible for the build to ever pass withmaxIssues: 0if the current wording were true.The current wording led to an issue in Duolingo's codebase where we were declaring
maxIssues: 1to mean "break if at least one issue is found" and unknowingly allowing our repo to always contain exactly 1 unfixed violation. This confused contributors because two new PRs each introducing one violation would often be merged around the same time into master, adding up to two violations and breaking master.