Add a note to FloggerArgumentToString that Flogger handles arrays and…

… such nicely. PiperOrigin-RevId: 691960142
google · Oct 31, 2024 · d173d85 · d173d85
1 parent f0c3c1e
commit d173d85
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/core/src/main/java/com/google/errorprone/bugpatterns/flogger/FloggerArgumentToString.java b/core/src/main/java/com/google/errorprone/bugpatterns/flogger/FloggerArgumentToString.java
@@ -56,7 +56,8 @@
 @BugPattern(
     summary =
         "Use Flogger's printf-style formatting instead of explicitly converting arguments to"
-            + " strings",
+            + " strings. Note that Flogger does more than just call toString; for instance, it"
+            + " formats arrays sensibly.",
     severity = WARNING)
 public class FloggerArgumentToString extends BugChecker implements MethodInvocationTreeMatcher {