Skip to content

Check for public companion object for UndocumentedPublicClass#7219

Merged
BraisGabin merged 2 commits into
detekt:mainfrom
atulgpt:fixes/7217/fix-undocumented
Apr 26, 2024
Merged

Check for public companion object for UndocumentedPublicClass#7219
BraisGabin merged 2 commits into
detekt:mainfrom
atulgpt:fixes/7217/fix-undocumented

Conversation

@atulgpt
Copy link
Copy Markdown
Contributor

@atulgpt atulgpt commented Apr 23, 2024

Fixes #7217

@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 23, 2024

Codecov Report

Attention: Patch coverage is 80.00000% with 2 lines in your changes are missing coverage. Please review.

Project coverage is 84.71%. Comparing base (9368039) to head (9c957df).

Files Patch % Lines
...ekt/rules/documentation/UndocumentedPublicClass.kt 80.00% 0 Missing and 2 partials ⚠️
Additional details and impacted files
@@             Coverage Diff              @@
##               main    #7219      +/-   ##
============================================
+ Coverage     84.70%   84.71%   +0.01%     
- Complexity     3983     3986       +3     
============================================
  Files           578      578              
  Lines         12151    12156       +5     
  Branches       2495     2498       +3     
============================================
+ Hits          10292    10298       +6     
  Misses          625      625              
+ Partials       1234     1233       -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@BraisGabin BraisGabin added the pick request Marker for PRs that should be ported to the 1.0 release branch label Apr 26, 2024
@BraisGabin BraisGabin merged commit 785ca96 into detekt:main Apr 26, 2024
@detekt-ci
Copy link
Copy Markdown
Collaborator

Warnings
⚠️ This PR is approved with no milestone set. If merged, it won't appear in the detekt release notes.

Generated by 🚫 dangerJS against 9c957df

@atulgpt atulgpt deleted the fixes/7217/fix-undocumented branch April 26, 2024 13:31
@3flex 3flex added this to the 2.0.0 milestone May 1, 2024
Nava2 added a commit to Nava2/detekt that referenced this pull request Sep 13, 2024
…g `companion object` without name

Closes detekt#7634 in favour of leaving the rule as described with configuration to disable to pre-detekt#7219 value.
BraisGabin pushed a commit that referenced this pull request Oct 19, 2024
#7635)

* Issue #7634: Make `UndocumentedPublicClass` configurable to flag `companion object` without name

Closes #7634 in favour of leaving the rule as described with configuration to disable to pre-#7219 value.

* fix detekt violations

* fix name

* address naming comments, add new test

* lint

* address comments, add more tests for edge case

* remove text look-up, replace with nameIdentifier check

* detekt

* fix compilation for examples
cortinico pushed a commit that referenced this pull request Jan 17, 2025
#7635)

* Issue #7634: Make `UndocumentedPublicClass` configurable to flag `companion object` without name

Closes #7634 in favour of leaving the rule as described with configuration to disable to pre-#7219 value.

* fix detekt violations

* fix name

* address naming comments, add new test

* lint

* address comments, add more tests for edge case

* remove text look-up, replace with nameIdentifier check

* detekt

* fix compilation for examples
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

pick request Marker for PRs that should be ported to the 1.0 release branch rules

Projects

None yet

Development

Successfully merging this pull request may close these issues.

False negative for companion object in UndocumentedPublicClass

4 participants