Skip to content
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

Fix document #3765

Merged
merged 5 commits into from
May 13, 2021
Merged

Fix document #3765

merged 5 commits into from
May 13, 2021

Conversation

zmunm
Copy link
Contributor

@zmunm zmunm commented May 12, 2021

I fix some documentation.

By the way, it would be nice if lint of non-compliant blocks and compliant blocks could also be checked in the ci process. At least itself
If possible, I will open it as a separate issue.

@codecov
Copy link

codecov bot commented May 12, 2021

Codecov Report

Merging #3765 (f7011dc) into main (4d80329) will increase coverage by 0.04%.
The diff coverage is n/a.

Impacted file tree graph

@@             Coverage Diff              @@
##               main    #3765      +/-   ##
============================================
+ Coverage     83.48%   83.52%   +0.04%     
- Complexity     2914     2915       +1     
============================================
  Files           452      452              
  Lines          8766     8765       -1     
  Branches       1664     1665       +1     
============================================
+ Hits           7318     7321       +3     
+ Misses          544      542       -2     
+ Partials        904      902       -2     
Impacted Files Coverage Δ Complexity Δ
...etekt/rules/coroutines/RedundantSuspendModifier.kt 57.14% <ø> (ø) 20.00 <0.00> (ø)
...h/detekt/rules/documentation/DeprecatedBlockTag.kt 93.75% <ø> (ø) 5.00 <0.00> (ø)
...ab/arturbosch/detekt/rules/bugs/ExitOutsideMain.kt 66.66% <ø> (ø) 4.00 <0.00> (ø)
...ab/arturbosch/detekt/rules/bugs/HasPlatformType.kt 68.00% <ø> (ø) 11.00 <0.00> (ø)
...arturbosch/detekt/rules/bugs/IgnoredReturnValue.kt 83.33% <ø> (ø) 10.00 <0.00> (ø)
...kt/rules/exceptions/InstanceOfCheckForException.kt 76.19% <ø> (ø) 8.00 <0.00> (ø)
...lab/arturbosch/detekt/rules/style/ModifierOrder.kt 100.00% <ø> (ø) 3.00 <0.00> (ø)
...h/detekt/rules/style/MultilineLambdaItParameter.kt 87.09% <ø> (ø) 13.00 <0.00> (ø)
...rbosch/detekt/rules/style/RedundantExplicitType.kt 65.62% <ø> (ø) 15.00 <0.00> (ø)
...b/arturbosch/detekt/rules/style/UseCheckOrError.kt 91.66% <ø> (ø) 8.00 <0.00> (ø)
... and 4 more

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 4d80329...f7011dc. Read the comment docs.

@@ -43,11 +43,11 @@ import org.jetbrains.kotlin.psi.psiUtil.allChildren
* taken from: http://kotlinlang.org/docs/reference/coding-conventions.html#modifiers
*
* <noncompliant>
* lateinit internal private val str: String
* lateinit internal val str: String
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* lateinit internal val str: String
* lateinit internal var str: String

* </noncompliant>
*
* <compliant>
* private internal lateinit val str: String
* internal lateinit val str: String
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* internal lateinit val str: String
* internal lateinit var str: String

@BraisGabin
Copy link
Member

Thanks for the pr! I think that compile the snippets should not be too complex. But I'm not sure how much false positives we will have.

@BraisGabin BraisGabin merged commit a592a37 into detekt:main May 13, 2021
@cortinico cortinico added this to the 1.17.0 milestone May 13, 2021
@cortinico cortinico added the housekeeping Marker for housekeeping tasks and refactorings label May 13, 2021
@zmunm zmunm deleted the fix-document branch May 13, 2021 11:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
housekeeping Marker for housekeeping tasks and refactorings
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants