From 461754df83ba39cc7313f40b5c5cc34c26b30e4a Mon Sep 17 00:00:00 2001
From: Stephan Schroevers <stephan.schroevers@teampicnic.com>
Date: Sun, 31 Dec 2017 16:07:06 +0100
Subject: [PATCH] Document `Slf4jLogStatementCheck` caveat

---
 .../errorprone/bugpatterns/Slf4jLogStatementCheck.java          | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/error-prone-contrib/src/main/java/com/picnicinternational/errorprone/bugpatterns/Slf4jLogStatementCheck.java b/error-prone-contrib/src/main/java/com/picnicinternational/errorprone/bugpatterns/Slf4jLogStatementCheck.java
index 9a93fdc5..261cad35 100644
--- a/error-prone-contrib/src/main/java/com/picnicinternational/errorprone/bugpatterns/Slf4jLogStatementCheck.java
+++ b/error-prone-contrib/src/main/java/com/picnicinternational/errorprone/bugpatterns/Slf4jLogStatementCheck.java
@@ -26,6 +26,8 @@ import java.util.List;
 import java.util.Optional;
 import java.util.regex.Pattern;
 
+// XXX: The special-casing of Throwable applies only to SLF4J 1.6.0+; see https://www.slf4j.org/faq.html#paramException.
+//      That should be documented.
 // XXX: Also simplify `LOG.error(String.format("Something %s", arg), throwable)`.
 // XXX: Write a similar checker for Spring RestTemplates, String.format and friends, Guava
 // preconditions, ...