Clarify threshold pararameter meaning in docs #1974
Merged
Conversation
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
schalkms
approved these changes
Oct 4, 2019
Member
schalkms
left a comment
There was a problem hiding this comment.
Thanks for improving the documentation! 👍
smyachenkov
pushed a commit
to smyachenkov/detekt
that referenced
this pull request
Dec 9, 2019
* Clarify threshold pararameter meaning in docs * Couple more minor docs fixes * Regenerate complexity ruleset doc
smyachenkov
pushed a commit
to smyachenkov/detekt
that referenced
this pull request
Dec 9, 2019
* Clarify threshold pararameter meaning in docs * Couple more minor docs fixes * Regenerate complexity ruleset doc
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
In most cases the
thresholdparameter is documented as the maximum number of instances possible before the rule triggers, but it's actually the number required to trigger a rule, as all the conditions are of the form>= threshold. Hopefully this will make the documenation clearer.