Skip to content

Add the GAV coordinates of the annotations to the documentation#3137

Merged
hazendaz merged 4 commits intospotbugs:masterfrom
gtoison:issue-3110
Oct 6, 2024
Merged

Add the GAV coordinates of the annotations to the documentation#3137
hazendaz merged 4 commits intospotbugs:masterfrom
gtoison:issue-3110

Conversation

@gtoison
Copy link
Copy Markdown
Contributor

@gtoison gtoison commented Oct 1, 2024

This should fix #3110

@gtoison
Copy link
Copy Markdown
Contributor Author

gtoison commented Oct 1, 2024

The updated page is available here: https://spotbugs--3137.org.readthedocs.build/en/3137/annotations.html
I did not write a translation in Japanese or Portuguese because I don't know these languages, but hopefully this Maven or Gradle dependency declarations are self-explanatory

Copy link
Copy Markdown
Collaborator

@JuditKnoll JuditKnoll left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment on lines +9 to +15
.. parsed-literal::

<dependency>
<groupId>com.github.spotbugs</groupId>
<artifactId>spotbugs-annotations</artifactId>
<version>\ |release|\ </version>
</dependency>
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you please specify the language so there is syntax highlight?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for letting me know 😄

@gtoison
Copy link
Copy Markdown
Contributor Author

gtoison commented Oct 1, 2024

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.

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 think it makes sense to have them on the Annotations page, but let me know if you see a better place

@JuditKnoll
Copy link
Copy Markdown
Collaborator

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.

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 think it makes sense to have them on the Annotations page, but let me know if you see a better place

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.

@hazendaz hazendaz merged commit b42b24a into spotbugs:master Oct 6, 2024
@hazendaz hazendaz added this to the SpotBugs 4.9.0 milestone Oct 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

The documation on the annotations should state which depdency is required

3 participants