error-prone icon indicating copy to clipboard operation
error-prone copied to clipboard

StringCharset BugPattern summary is not helpful

Open JuditKnoll opened this issue 1 year ago • 0 comments

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)

JuditKnoll avatar Apr 04 '24 11:04 JuditKnoll