Remove incorrect statement from BugPattern index doc

#4248 Fixes #4249 COPYBARA_INTEGRATE_REVIEW=#4249 from elkkhan:doc-remove-bugpattern-examples-statement 8c7cf54 PiperOrigin-RevId: 597571000
google · Jan 11, 2024 · 5a68588 · 5a68588
1 parent 817b442
commit 5a68588
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 12 deletions.
diff --git a/docgen/src/main/java/com/google/errorprone/resources/bugpatterns_external.mustache b/docgen/src/main/java/com/google/errorprone/resources/bugpatterns_external.mustache
@@ -4,9 +4,7 @@
 
 # Bug patterns
 
-This list is auto-generated from our sources. Each bug pattern includes code
-examples of both positive and negative cases; these examples are used in our
-regression test suite.
+This list is auto-generated from our sources.
 
 Patterns which are marked __Experimental__ will not be evaluated against your
 code, unless you specifically configure Error Prone. The default checks are

diff --git a/docgen/src/main/java/com/google/errorprone/resources/bugpatterns_internal.mustache b/docgen/src/main/java/com/google/errorprone/resources/bugpatterns_internal.mustache
@@ -2,9 +2,7 @@
 
 [TOC]
 
-This list is auto-generated from our sources. Each bug pattern includes code
-examples of both positive and negative cases; these examples are used in our
-regression test suite.
+This list is auto-generated from our sources.
 
 Patterns which are marked __Experimental__ will not be evaluated against your
 code, unless you specifically configure Error Prone. The default checks are

diff --git a/docgen/src/test/java/com/google/errorprone/BugPatternIndexWriterTest.java b/docgen/src/test/java/com/google/errorprone/BugPatternIndexWriterTest.java
@@ -59,9 +59,7 @@ public void dumpInternal() throws Exception {
         .isEqualTo(
             "# Bug patterns\n\n"
                 + "[TOC]\n\n"
-                + "This list is auto-generated from our sources. Each bug pattern includes code\n"
-                + "examples of both positive and negative cases; these examples are used in our\n"
-                + "regression test suite.\n"
+                + "This list is auto-generated from our sources.\n"
                 + "\n"
                 + "Patterns which are marked __Experimental__ will not be evaluated against your\n"
                 + "code, unless you specifically configure Error Prone. The default checks are\n"
@@ -116,9 +114,7 @@ public void dumpExternal() throws Exception {
                 + "---\n\n\n"
                 + "# Bug patterns\n"
                 + "\n"
-                + "This list is auto-generated from our sources. Each bug pattern includes code\n"
-                + "examples of both positive and negative cases; these examples are used in our\n"
-                + "regression test suite.\n"
+                + "This list is auto-generated from our sources.\n"
                 + "\n"
                 + "Patterns which are marked __Experimental__ will not be evaluated against your\n"
                 + "code, unless you specifically configure Error Prone. The default checks are\n"