From 5a68588eadbb2eb4d558c85bb47d98aa38098a20 Mon Sep 17 00:00:00 2001 From: Elkhan Eminov Date: Thu, 11 Jan 2024 09:03:18 -0800 Subject: [PATCH] Remove incorrect statement from BugPattern index doc #4248 Fixes #4249 COPYBARA_INTEGRATE_REVIEW=https://github.com/google/error-prone/pull/4249 from elkkhan:doc-remove-bugpattern-examples-statement 8c7cf54e2ad19b05d52461be8cd78597056c4f65 PiperOrigin-RevId: 597571000 --- .../errorprone/resources/bugpatterns_external.mustache | 4 +--- .../errorprone/resources/bugpatterns_internal.mustache | 4 +--- .../com/google/errorprone/BugPatternIndexWriterTest.java | 8 ++------ 3 files changed, 4 insertions(+), 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 index d6cba31698e..02980ef5611 100644 --- 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 index 4b521cc5fb1..125fad57c70 100644 --- 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 index 1f0039d26ae..e244b6689ae 100644 --- 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"