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

Please update documentation #422

Open
nkavian opened this issue Aug 29, 2021 · 4 comments
Open

Please update documentation #422

nkavian opened this issue Aug 29, 2021 · 4 comments

Comments

@nkavian
Copy link

nkavian commented Aug 29, 2021

This page sends people, myself included, to the fb-contrib page. When I used it, it broke because I really needed to be using the sb-contrib.

It might help to update this so people stop creating new tickets complaining that bsel is out of date, etc.

http://fb-contrib.sourceforge.net/

@ThrawnCA
Copy link
Contributor

The SourceForge page isn't really maintained anymore; it points you toward the GitHub page, which mentions the different versions for FindBugs vs SpotBugs.

Which link in particular did you find problematic?

@nkavian
Copy link
Author

nkavian commented Aug 30, 2021

Both links on that page which take you to the maven repository

image

Once I got there I copied/pasted the artifact, not knowing I should be using the sb-contrib version instead

image

It wasn't until I had bcel version issues that I then went through the github issues just to see and realize I need to switch to sb-contrib.

@ThrawnCA
Copy link
Contributor

Those links are correct for fb-contrib, though, and the page does say that it's meant to be used with FindBugs (not SpotBugs).

I suppose it wouldn't hurt for there to be some mention on the page that FindBugs itself is obsolete. But it's basically an unmaintained page.

@nkavian
Copy link
Author

nkavian commented Aug 31, 2021

The way spotbugs is documented, the average person won't understand what is and is-not deprecated or obsolete.

Go to the repo page and search for the word obsolete, no match. The way everything is displayed, it's as if they're both alive and well.

image
image

It's ironic. A tool that helps developers find subtle programming bugs itself is unclear how it can be used. Configuring maven was a nightmare too but that's for a different day.

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

No branches or pull requests

3 participants