Skip to content

Fix false positive in UndocumentedPublicClass#2588

Merged
arturbosch merged 2 commits into
detekt:masterfrom
schalkms:fix-#2580-UndocumentedPublicClass
Apr 11, 2020
Merged

Fix false positive in UndocumentedPublicClass#2588
arturbosch merged 2 commits into
detekt:masterfrom
schalkms:fix-#2580-UndocumentedPublicClass

Conversation

@schalkms
Copy link
Copy Markdown
Member

@schalkms schalkms commented Apr 7, 2020

Classes that are nested, non-public and undocumented are not flagged by this rule anymore.

Closes #2580

@BraisGabin
Copy link
Copy Markdown
Member

You are talking about UndocumentedPublicClass but you edited UndocumentedPublicProperty.

Classes that are nested, non-public and undocumented are not flagged by this rule anymore.

Closes #2580
@schalkms
Copy link
Copy Markdown
Member Author

schalkms commented Apr 7, 2020

@BraisGabin thanks for that. I pushed the wrong branch, since I separated this issue (UndocumentedPublicClass + UndocumentedPublicProperty).

@codecov-io
Copy link
Copy Markdown

codecov-io commented Apr 7, 2020

Codecov Report

Merging #2588 into master will decrease coverage by 0.02%.
The diff coverage is 0.00%.

Impacted file tree graph

@@             Coverage Diff              @@
##             master    #2588      +/-   ##
============================================
- Coverage     25.20%   25.18%   -0.03%     
  Complexity      394      394              
============================================
  Files           379      379              
  Lines          7418     7425       +7     
  Branches       1225     1227       +2     
============================================
  Hits           1870     1870              
- Misses         5417     5424       +7     
  Partials        131      131              
Impacted Files Coverage Δ Complexity Δ
...in/io/gitlab/arturbosch/detekt/rules/Traversing.kt 0.00% <0.00%> (ø) 0.00 <0.00> (ø)
...ekt/rules/documentation/UndocumentedPublicClass.kt 31.03% <0.00%> (-1.11%) 1.00 <0.00> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3450420...df96ec0. Read the comment docs.

@arturbosch arturbosch added this to the 1.8.0 milestone Apr 11, 2020
@arturbosch arturbosch merged commit 9348e86 into detekt:master Apr 11, 2020
@schalkms schalkms deleted the fix-#2580-UndocumentedPublicClass branch April 12, 2020 17:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

UndocumentedPublicClass false positive for inner types

4 participants