Skip to content

Use annotation to configure rules in rules-documentation #3770

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

Merged
merged 4 commits into from
May 22, 2021

Conversation

marschwar
Copy link
Contributor

This belongs to #3670 and replaces all configuration kdoc tags in rules-documentation with annotations.

@codecov
Copy link

codecov bot commented May 12, 2021

Codecov Report

Merging #3770 (5dbf34c) into main (21b7d7c) will decrease coverage by 0.00%.
The diff coverage is 100.00%.

Impacted file tree graph

@@             Coverage Diff              @@
##               main    #3770      +/-   ##
============================================
- Coverage     83.52%   83.51%   -0.01%     
+ Complexity     2915     2914       -1     
============================================
  Files           452      452              
  Lines          8765     8760       -5     
  Branches       1665     1665              
============================================
- Hits           7321     7316       -5     
  Misses          542      542              
  Partials        902      902              
Impacted Files Coverage Δ Complexity Δ
...kt/rules/documentation/AbsentOrWrongFileLicense.kt 89.47% <100.00%> (+1.23%) 12.00 <0.00> (ø)
.../detekt/rules/documentation/EndOfSentenceFormat.kt 95.23% <100.00%> (ø) 12.00 <0.00> (ø)
...ekt/rules/documentation/UndocumentedPublicClass.kt 87.50% <100.00%> (ø) 33.00 <0.00> (ø)
...arturbosch/detekt/rules/bugs/IgnoredReturnValue.kt 79.16% <0.00%> (-4.17%) 9.00% <0.00%> (-1.00%)
...otlin/io/github/detekt/custom/SpekTestDiscovery.kt 62.96% <0.00%> (-1.33%) 11.00% <0.00%> (ø%)
...b/arturbosch/detekt/rules/empty/EmptyCatchBlock.kt 88.88% <0.00%> (ø) 3.00% <0.00%> (ø%)
...tlab/arturbosch/detekt/rules/bugs/LateinitUsage.kt 89.47% <0.00%> (ø) 7.00% <0.00%> (ø%)
...ab/arturbosch/detekt/rules/bugs/MissingWhenCase.kt 87.50% <0.00%> (ø) 12.00% <0.00%> (ø%)
...rbosch/detekt/rules/bugs/ImplicitUnitReturnType.kt 81.48% <0.00%> (ø) 10.00% <0.00%> (ø%)
...rturbosch/detekt/rules/empty/EmptyFunctionBlock.kt 92.85% <0.00%> (+0.54%) 12.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 21b7d7c...5dbf34c. Read the comment docs.

@cortinico cortinico added this to the 1.18.0 milestone May 14, 2021
Co-authored-by: Brais Gabín <braisgabin@gmail.com>
@chao2zhang chao2zhang merged commit 0c6267f into detekt:main May 22, 2021
@marschwar marschwar deleted the annotation-rules-documentation branch May 24, 2021 12:42
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.

5 participants