Skip to content

Make kotlinc adapted rule comments internal #3190

@BraisGabin

Description

@BraisGabin

Some of our rules are adaptations from other rules in the kotlin compiler or other sources. We usually add a comment in the code poiting this out and that's good. This way we give credit and in case of bug we can check the source to see if they fixed it already.

But those comments are appearing in our documentation, for example: https://detekt.github.io/detekt/style.html#uselesscallonnotnull or #3187 (review)

I think that this references should not appear in the documentation because they give nearly 0 value to our users and it can be missleading.

My proposal is to remove those comments from the double asterisk comment block and move it to a single asterisk comment block. What do you think?

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions