Add documentation for the suppressors

[BraisGabin]

closes #4440

[codecov]

Codecov Report

Merging #4451 (a1a8e0e) into main (21a751a) will decrease coverage by 0.01%.
The diff coverage is n/a.

@@             Coverage Diff              @@
##               main    #4451      +/-   ##
============================================
- Coverage     84.34%   84.32%   -0.02%     
+ Complexity     3299     3298       -1     
============================================
  Files           473      473              
  Lines         10532    10591      +59     
  Branches       1885     1907      +22     
============================================
+ Hits           8883     8931      +48     
- Misses          671      675       +4     
- Partials        978      985       +7     

Impacted Files	Coverage Δ
...ch/detekt/core/suppressors/AnnotationSuppressor.kt	80.76% <ø> (ø)
...osch/detekt/core/suppressors/FunctionSuppressor.kt	100.00% <ø> (ø)
...osch/detekt/core/baseline/BaselineResultMapping.kt	78.57% <0.00%> (-2.68%)	⬇️
...lab/arturbosch/detekt/rules/style/VarCouldBeVal.kt	87.50% <0.00%> (-2.09%)	⬇️
...io/gitlab/arturbosch/detekt/core/BindingContext.kt	41.17% <0.00%> (+5.17%)	⬆️
.../arturbosch/detekt/core/baseline/BaselineFacade.kt	85.71% <0.00%> (+5.71%)	⬆️

---

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 21a751a...a1a8e0e. Read the comment docs.

[cortinico]

Amazing work! 🎉

[cortinico]

Please put this on a single line

[BraisGabin]

👍 Can I ask why do you prefer them in one line instead of wrapping the lines? I do like them more in a single line but I added them like this to be "safe"

[cortinico]

It reads better on every Markdown processors. Generally, MD processors wrap long lines so it's easier to find paragraph breaks, regardless of the width of the reader's screen.

If you add newlines in the middle of the paragraph, then the line wrapping will still happen + the newlines will be rendered as well. So sometimes you end up with 2 words on a line for no apparent reason, and so on.