-
-
Notifications
You must be signed in to change notification settings - Fork 784
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Reorganize docs for the configuration file #3337
Conversation
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
Co-authored-by: Brais Gabín <braisgabin@gmail.com>
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
_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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We have a mix and match of Detekt
and detekt
across the documentation and README.md though, have we agreed upon preferring Detekt
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure though. However, this is the beginning of a sentence. Hence, it starts with one capital letter.
* Reorganize docs for the configuration file * Update docs/pages/configurations.md Co-authored-by: Brais Gabín <braisgabin@gmail.com> * Correct misplaced statements * Use better wording in doc Co-authored-by: Brais Gabín <braisgabin@gmail.com> Co-authored-by: M Schalk <30376729+schalkms@users.noreply.github.com>
Fun fact: Some of the new discussions like #3279 (comment) are already documented in the
Path Filters / Excludes / Includes
section.