-
-
Notifications
You must be signed in to change notification settings - Fork 755
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
Add documentation for the suppressors #4451
Conversation
Codecov Report
@@ Coverage Diff @@
## main #4451 +/- ##
============================================
- Coverage 84.34% 84.32% -0.02%
+ Complexity 3299 3298 -1
============================================
Files 473 473
Lines 10532 10591 +59
Branches 1885 1907 +22
============================================
+ Hits 8883 8931 +48
- Misses 671 675 +4
- Partials 978 985 +7
Continue to review full report at Codecov.
|
detekt-core/src/main/kotlin/io/gitlab/arturbosch/detekt/core/suppressors/FunctionSuppressor.kt
Outdated
Show resolved
Hide resolved
detekt-core/src/main/kotlin/io/gitlab/arturbosch/detekt/core/suppressors/FunctionSuppressor.kt
Outdated
Show resolved
Hide resolved
Co-authored-by: M Schalk <30376729+schalkms@users.noreply.github.com>
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.
Amazing work! 🎉
docs/pages/suppressors.md
Outdated
--- | ||
|
||
The `Suppressor`s are a tool that you can use to customize the reports of detekt. They allow you to (surprise) suppress | ||
some issues detected by some rules, and they can be applied to any rule. |
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.
Please put this on a single line
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.
👍 Can I ask why do you prefer them in one line instead of wrapping the lines? I do like them more in a single line but I added them like this to be "safe"
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.
It reads better on every Markdown processors. Generally, MD processors wrap long lines so it's easier to find paragraph breaks, regardless of the width of the reader's screen.
If you add newlines in the middle of the paragraph, then the line wrapping will still happen + the newlines will be rendered as well. So sometimes you end up with 2 words on a line for no apparent reason, and so on.
Co-authored-by: Nicola Corti <corti.nico@gmail.com>
closes #4440