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

Add documentation for Suppressors #4440

Closed
BraisGabin opened this issue Jan 2, 2022 · 1 comment · Fixed by #4451
Closed

Add documentation for Suppressors #4440

BraisGabin opened this issue Jan 2, 2022 · 1 comment · Fixed by #4451

Comments

@BraisGabin
Copy link
Member

The Suppressors is a new concpet introduced in detekt 1.19.0 to give more flexibilty to ignore some issues. But it is not documented yet. So we should add a new documentation to it.

The problem here is: should it be automated? So any new Suppressor automatically adds it's documentation? Or should iy be an static code?

@BraisGabin BraisGabin added this to the 1.20.0 milestone Jan 2, 2022
@schalkms
Copy link
Member

schalkms commented Jan 2, 2022

In my opinion, it could be a mixture of both.

  1. Use a separate entry on detekt's home page.
  2. Document the code inline. This way, one can look into the code and grasp more details if necessary.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants