-
-
Notifications
You must be signed in to change notification settings - Fork 794
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
Broken link at EmptyFunctionBlock #5604
Conversation
|
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.
Thank you!
@@ -77,9 +77,9 @@ Reports empty `for` loops. Empty blocks of code serve no purpose and should be r | |||
|
|||
Reports empty functions. Empty blocks of code serve no purpose and should be removed. | |||
This rule will not report functions with the override modifier that have a comment as their only body contents | |||
(e.g., a // no-op comment in an unused listener function). | |||
(e.g., a `// no-op comment` in an unused listener function). |
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.
@cortinico Do we recommend to update versioned docs when updating the documentation? It seems to me that we should only the current version of the detekt doc and the versioned doc changes are only necessary for critical changes or notes
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.
For critical documentation bugs this should be a must but for this kind of issues I think it is a nice to have. It's not necessary but, if it's done, it should be more than welcome.
@@ -77,9 +77,9 @@ Reports empty `for` loops. Empty blocks of code serve no purpose and should be r | |||
|
|||
Reports empty functions. Empty blocks of code serve no purpose and should be removed. | |||
This rule will not report functions with the override modifier that have a comment as their only body contents | |||
(e.g., a // no-op comment in an unused listener function). | |||
(e.g., a `// no-op comment` in an unused listener function). |
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.
For critical documentation bugs this should be a must but for this kind of issues I think it is a nice to have. It's not necessary but, if it's done, it should be more than welcome.
Co-authored-by: Brais Gabín <braisgabin@gmail.com>
Codecov Report
@@ Coverage Diff @@
## main #5604 +/- ##
===========================================
+ Coverage 0 85.89% +85.89%
- Complexity 0 3637 +3637
===========================================
Files 0 516 +516
Lines 0 12179 +12179
Branches 0 2171 +2171
===========================================
+ Hits 0 10461 +10461
- Misses 0 628 +628
- Partials 0 1090 +1090
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
A similar PR may already be submitted!
Please search among the Pull requests before creating one.
Thanks for submitting a pull request! Please provide enough information so that others can review your pull request. Link to relevant issues if possible.
The documentation of EmptyFunctionBlock has a "broken link":
Set the [ignoreOverridden] parameter to...
Fixes #5601
For more information, see the CONTRIBUTING guide.