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

Change @autocorrect from tag to annotation #3820

Merged
merged 3 commits into from
May 24, 2021

Conversation

chao2zhang
Copy link
Member

@chao2zhang chao2zhang commented May 22, 2021

Continuing #3562, this PR moves @autocorrect from tag to a Kotlin annotation class.

Note: This PR is not intend for improving the functionality, such as displaying the autocorrectable status, along with the since field, in our docs.

@cortinico cortinico added this to the 1.18.0 milestone May 22, 2021
@cortinico cortinico added the notable changes Marker for notable changes in the changelog label May 22, 2021
@codecov
Copy link

codecov bot commented May 22, 2021

Codecov Report

Merging #3820 (09d8424) into main (a604c4f) will decrease coverage by 0.10%.
The diff coverage is 100.00%.

Impacted file tree graph

@@             Coverage Diff              @@
##               main    #3820      +/-   ##
============================================
- Coverage     83.58%   83.47%   -0.11%     
- Complexity     3055     3104      +49     
============================================
  Files           456      456              
  Lines          8916     8936      +20     
  Branches       1752     1751       -1     
============================================
+ Hits           7452     7459       +7     
- Misses          541      559      +18     
+ Partials        923      918       -5     
Impacted Files Coverage Δ Complexity Δ
...kt/formatting/wrappers/AnnotationOnSeparateLine.kt 100.00% <ø> (ø) 3.00 <0.00> (ø)
...ch/detekt/formatting/wrappers/AnnotationSpacing.kt 100.00% <ø> (ø) 3.00 <0.00> (ø)
...detekt/formatting/wrappers/ArgumentListWrapping.kt 90.00% <ø> (ø) 4.00 <0.00> (ø)
...rbosch/detekt/formatting/wrappers/ChainWrapping.kt 100.00% <ø> (ø) 3.00 <0.00> (ø)
...bosch/detekt/formatting/wrappers/CommentSpacing.kt 100.00% <ø> (ø) 3.00 <0.00> (ø)
...ch/detekt/formatting/wrappers/EnumEntryNameCase.kt 100.00% <ø> (ø) 3.00 <0.00> (ø)
...urbosch/detekt/formatting/wrappers/FinalNewline.kt 100.00% <ø> (ø) 4.00 <0.00> (ø)
...bosch/detekt/formatting/wrappers/ImportOrdering.kt 100.00% <ø> (ø) 7.00 <0.00> (ø)
...turbosch/detekt/formatting/wrappers/Indentation.kt 100.00% <ø> (ø) 4.00 <0.00> (ø)
...sch/detekt/formatting/wrappers/ModifierOrdering.kt 100.00% <ø> (ø) 3.00 <0.00> (ø)
... and 75 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 a604c4f...09d8424. Read the comment docs.

Copy link
Member

@schalkms schalkms left a comment

Choose a reason for hiding this comment

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

Can you please do a quick search whether autocorrectable is used in any of the doc pages?

chao2zhang and others added 2 commits May 23, 2021 08:45
…ernal/AutoCorrectable.kt

Co-authored-by: M Schalk <30376729+schalkms@users.noreply.github.com>
…ernal/AutoCorrectable.kt

Co-authored-by: M Schalk <30376729+schalkms@users.noreply.github.com>
@chao2zhang
Copy link
Member Author

autocorrectable, auto-correctable and auto correctable did not appear in any user-generated text in our docs. The only places it shows up is the generated detekt-api docs.

@BraisGabin BraisGabin merged commit 43bbc8c into detekt:main May 24, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
notable changes Marker for notable changes in the changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants