Add the GAV coordinates of the annotations to the documentation#3137
Add the GAV coordinates of the annotations to the documentation#3137hazendaz merged 4 commits intospotbugs:masterfrom
Conversation
|
The updated page is available here: https://spotbugs--3137.org.readthedocs.build/en/3137/annotations.html |
JuditKnoll
left a comment
There was a problem hiding this comment.
I'm not convinced, that this is the best place for these infos. IMO it would be better to have it elsewhere and just refer that in the annotations page.
There are already some info, how these can be used at the FindBugs -> SpotBugs migration, but that's a bit different context.
docs/annotations.rst
Outdated
| .. parsed-literal:: | ||
|
|
||
| <dependency> | ||
| <groupId>com.github.spotbugs</groupId> | ||
| <artifactId>spotbugs-annotations</artifactId> | ||
| <version>\ |release|\ </version> | ||
| </dependency> |
There was a problem hiding this comment.
Can you please specify the language so there is syntax highlight?
There was a problem hiding this comment.
Thank you for pointing out the migration page: apparently parsed-literal does not work with code and language aware syntax coloring but Kengo had found a way around this in #451
There was a problem hiding this comment.
Thanks for letting me know 😄
I initially thought about adding this on the README page but I'm worried that some users might think that the annotation library IS spotbugs (and merely add the dependency but wont actually analyze the project). |
I was first thinking on the Using the SpotBugs Maven / Gradle Plugin pages, but you are right, that could cause confusion. I can't find any better place, it's okay like this. |
This should fix #3110