Add an explanation for ThreadPriorityCheck

Fixes #1503 PiperOrigin-RevId: 350677546
google · Jan 8, 2021 · a5f3056 · a5f3056
1 parent f65797b
commit a5f3056
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 3 deletions.
diff --git a/core/src/main/java/com/google/errorprone/bugpatterns/threadsafety/ThreadPriorityCheck.java b/core/src/main/java/com/google/errorprone/bugpatterns/threadsafety/ThreadPriorityCheck.java
@@ -38,9 +38,7 @@
  */
 @BugPattern(
     name = "ThreadPriorityCheck",
-    summary =
-        "Relying on the thread scheduler is discouraged; "
-            + "see Effective Java 3rd Edition Item 84.",
+    summary = "Relying on the thread scheduler is discouraged.",
     severity = WARNING)
 public class ThreadPriorityCheck extends BugChecker implements MethodInvocationTreeMatcher {
 

diff --git a/docs/bugpattern/ThreadPriorityCheck.md b/docs/bugpattern/ThreadPriorityCheck.md
@@ -0,0 +1,8 @@
+Don't rely on the thread scheduler for correctness or performance. Instead,
+ensure that the average number of runnable threads is not significantly greater
+than the number of processors, i.e. by using the executor framework and an
+appropriately sized thread pool.
+
+For more information, see [Effective Java 3rd Edition §84][ej3e-84].
+
+[ej3e-84]: https://books.google.com/books?id=BIpDDwAAQBAJ