OutdatedDocumentation - Detect param which private property documented as property #6372
+75
−3
Conversation
This file contains 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 @@
## main #6372 +/- ##
=========================================
Coverage 85.16% 85.16%
+ Complexity 4010 4009 -1
=========================================
Files 570 570
Lines 13401 13398 -3
Branches 2363 2361 -2
=========================================
- Hits 11413 11411 -2
- Misses 834 835 +1
+ Partials 1154 1152 -2
|
TWiStErRob
reviewed
Aug 6, 2023
| @@ -147,7 +148,7 @@ class OutdatedDocumentation(config: Config = Config.empty) : Rule(config) { | |||
| private fun getDeclarationsForValueParameters(valueParameters: List<KtParameter>): List<Declaration> { | |||
| return valueParameters.mapNotNull { | |||
| it.name?.let { name -> | |||
| val type = if (it.isPropertyParameter()) { | |||
| val type = if (it.isPropertyParameter() && it.isPublic) { | |||
There was a problem hiding this comment.
probably !private? because protected is also public API. internal is arguable, but there are still external users outside the component itself, so docs are recomended.
There was a problem hiding this comment.
Nice catch.. updated the logic. Thanks
atulgpt
force-pushed
the
fixes/6362/fix-property-param
branch
from
cb1c3ab
to
148a8b7
Compare
cortinico
changed the title
BraisGabin
approved these changes
Aug 13, 2023
cortinico
added
the
pick request
cortinico
pushed a commit
that referenced
this pull request
Oct 30, 2023
…d as property (#6372) * Detect param which private property documented as property * Use not of private instead of public
rvandermeulen
added a commit
to mozilla-mobile/firefox-android
that referenced
this pull request
Nov 2, 2023
Behavior change from detekt/detekt#6372.
rvandermeulen
added a commit
to mozilla-mobile/firefox-android
that referenced
this pull request
Nov 2, 2023
Behavior change from detekt/detekt#6372.
mergify bot
pushed a commit
to mozilla-mobile/firefox-android
that referenced
this pull request
Nov 2, 2023
Behavior change from detekt/detekt#6372.
akliuxingyuan
pushed a commit
to fork-maintainers/iceraven-browser
that referenced
this pull request
Dec 18, 2023
Behavior change from detekt/detekt#6372.
mgroth0
pushed a commit
to mgroth0/detekt
that referenced
this pull request
Feb 11, 2024
…d as property (detekt#6372) * Detect param which private property documented as property * Use not of private instead of public
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fixes #6371