Reorganize docs for the configuration file #3337
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
Codecov Report
@@ Coverage Diff @@
## master #3337 +/- ##
============================================
- Coverage 80.34% 80.27% -0.08%
+ Complexity 2724 2718 -6
============================================
Files 445 445
Lines 8177 8239 +62
Branches 1555 1563 +8
============================================
+ Hits 6570 6614 +44
- Misses 774 785 +11
- Partials 833 840 +7 Continue to review full report at Codecov.
|
3cdef5d to
5d2779b
Compare
BraisGabin
reviewed
Dec 31, 2020
Co-authored-by: Brais Gabín <[email protected]>
BraisGabin
approved these changes
Dec 31, 2020
schalkms
approved these changes
Jan 7, 2021
docs/pages/configurations.md
Outdated
| and rule authors the ability to write *library only* rules. | ||
| This is the replacement for the `test-pattern` feature. | ||
| ## Build failure | ||
| _detekt_ supports the option to fail your build if a threshold of code smell issues is met. |
Member
There was a problem hiding this comment.
Suggested change
| _detekt_ supports the option to fail your build if a threshold of code smell issues is met. | |
| _Detekt_ supports the option to fail your build if a threshold of code smell issues is met. |
Member
Author
There was a problem hiding this comment.
We have a mix and match of Detekt and detekt across the documentation and README.md though, have we agreed upon preferring Detekt?
Member
There was a problem hiding this comment.
Not sure though. However, this is the beginning of a sentence. Hence, it starts with one capital letter.
arturbosch
pushed a commit
that referenced
this pull request
Jan 16, 2021
* Reorganize docs for the configuration file * Update docs/pages/configurations.md Co-authored-by: Brais Gabín <[email protected]> * Correct misplaced statements * Use better wording in doc Co-authored-by: Brais Gabín <[email protected]> Co-authored-by: M Schalk <[email protected]>
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.
Fun fact: Some of the new discussions like #3279 (comment) are already documented in the
Path Filters / Excludes / Includessection.