Skip to content

Replace @since KDoc tag with @SinceDetekt#3582

Closed
marschwar wants to merge 5 commits into
detekt:mainfrom
marschwar:annotations-since-detekt
Closed

Replace @since KDoc tag with @SinceDetekt#3582
marschwar wants to merge 5 commits into
detekt:mainfrom
marschwar:annotations-since-detekt

Conversation

@marschwar
Copy link
Copy Markdown
Contributor

This also belongs to #3562 and replaces the rarely used @since KDoc tag with a @SinceDetekt annotation. Name and structure are "inspired by" @kotlin.SinceKotlin.

@codecov
Copy link
Copy Markdown

codecov Bot commented Mar 20, 2021

Codecov Report

Merging #3582 (fbba503) into master (c32b041) will increase coverage by 0.00%.
The diff coverage is 79.62%.

❗ Current head fbba503 differs from pull request most recent head 21d97b9. Consider uploading reports for the commit 21d97b9 to get more accurate results
Impacted file tree graph

@@            Coverage Diff            @@
##             master    #3582   +/-   ##
=========================================
  Coverage     77.52%   77.53%           
- Complexity     2829     2831    +2     
=========================================
  Files           464      465    +1     
  Lines          8767     8784   +17     
  Branches       1713     1715    +2     
=========================================
+ Hits           6797     6811   +14     
  Misses         1046     1046           
- Partials        924      927    +3     
Impacted Files Coverage Δ Complexity Δ
...gitlab/arturbosch/detekt/generator/out/Markdown.kt 21.42% <0.00%> (ø) 4.00 <0.00> (ø)
...turbosch/detekt/rules/bugs/NullableToStringCall.kt 76.19% <0.00%> (ø) 21.00 <0.00> (ø)
...t/rules/naming/NonBooleanPropertyPrefixedWithIs.kt 85.18% <ø> (ø) 12.00 <0.00> (ø)
...b/arturbosch/detekt/rules/style/UseCheckNotNull.kt 90.90% <ø> (+0.90%) 5.00 <0.00> (+1.00)
...arturbosch/detekt/rules/style/UseRequireNotNull.kt 90.90% <ø> (ø) 5.00 <0.00> (ø)
...urbosch/detekt/generator/collection/Annotations.kt 55.55% <55.55%> (ø) 0.00 <0.00> (?)
...urbosch/detekt/generator/collection/RuleVisitor.kt 82.40% <78.26%> (+0.33%) 39.00 <5.00> (ø)
...lab/arturbosch/detekt/generator/collection/Rule.kt 93.33% <100.00%> (+0.47%) 10.00 <2.00> (+1.00)
...enerator/printer/rulesetpage/RuleSetPagePrinter.kt 90.24% <100.00%> (+2.43%) 16.00 <4.00> (ø)
...kt/rules/style/LibraryEntitiesShouldNotBePublic.kt 86.36% <100.00%> (+3.03%) 7.00 <0.00> (ø)
... and 2 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 c32b041...21d97b9. Read the comment docs.

@picklebento picklebento added this to the 1.17.0 milestone Mar 21, 2021
@cortinico
Copy link
Copy Markdown
Member

Can I ask you to rebase @marschwar?
Specifically the @since annotation was addressed in #3569. It was a stale annotation that clashed with the @active annotation we already have, so I've cleaned it up.

@marschwar
Copy link
Copy Markdown
Contributor Author

What do you mean by stale? If the @since tag should not be used, then I can just delete this PR. I was thinking there should be a @SinceDetekt and a @ActiveByDefault annotation. But maybe there is only the need for the latter. Let me know what you think.

@cortinico
Copy link
Copy Markdown
Member

What do you mean by stale?

We had a couple of occurrences and we were not really using it (e.g. in 1.16.0 we enabled several rules but never really annotated those with @since).

I belive we should have an @ActiveByDefault with a since : String parameter.

Base automatically changed from master to main March 21, 2021 18:44
@marschwar
Copy link
Copy Markdown
Contributor Author

Ok. I'll close this one.

@marschwar marschwar closed this Mar 21, 2021
@marschwar marschwar deleted the annotations-since-detekt branch May 22, 2021 11:06
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.

3 participants