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

StringCharset BugPattern summary is not helpful #4359

Open
JuditKnoll opened this issue Apr 4, 2024 · 0 comments
Open

StringCharset BugPattern summary is not helpful #4359

JuditKnoll opened this issue Apr 4, 2024 · 0 comments

Comments

@JuditKnoll
Copy link

JuditKnoll commented Apr 4, 2024

The summary for the StringCharset (documentation, code) BugPattern doesn't describe the problem well, is the same as the bugpattern's name. When a bug is reported, the users see the summary of the bug, and this summary is not really helpful deciding what to do to correct the code. To understand what the user should do, he/she needs to check out the documentation of the bugpattern.

See EqualsNaN bugpattern as a good example for having a great summary.

Error Prone version: 2.26.1 (and current master)

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

No branches or pull requests

1 participant