detekt-hint icon indicating copy to clipboard operation
detekt-hint copied to clipboard

Adding context to rules

Open Mkohm opened this issue 5 years ago • 2 comments

Since many programming principles can be confusing and easily misinterpreted, i think adding some context in the comment could be helpful. In addition to giving a rule of thumb when to use composition over inheritance one could also print the public interface of the different classes.

Mkohm avatar Jan 27 '20 16:01 Mkohm

Add a readme for each rule?

ntindle avatar Jan 28 '20 13:01 ntindle

@ntindle that is a good idea, and thanks for looking into the project! A readme/documentation defining the specifications should be created. As a beginning i think the project readme can contain this information.

Going back to the topic; how much context would be useful in such detections? The comment from the Bot would potentially be very long and make more noise than neccesary. Maybe an option to enable "verbose-super hint mode" could be nice. Just thinking out loud!

Mkohm avatar Jan 28 '20 19:01 Mkohm