Update test documentation to clarify purpose. (#2704)

apache · May 14, 2022 · 0642fb0 · 0642fb0
1 parent 1a0bb1e
commit 0642fb0
Showing 1 changed file with 8 additions and 2 deletions.
diff --git a/test/src/main/java/org/apache/accumulo/test/start/KeywordStartIT.java b/test/src/main/java/org/apache/accumulo/test/start/KeywordStartIT.java
@@ -102,8 +102,14 @@ public void testCheckDuplicates() {
     assertEquals(2, results.size());
   }
 
-  // Note: this test may fail in Eclipse, if the services files haven't been generated by the
-  // AutoService annotation processor
+  /**
+   * This test guards against accidental renaming or incorrect naming of the keyword used to
+   * identify the service. The keyword is used to access the commands via the command line, so
+   * changes are visible to users and should not be changed.
+   * <p>
+   * Note: this test may fail in Eclipse, if the services files haven't been generated by the
+   * AutoService annotation processor
+   */
   @Test
   @SuppressWarnings("deprecation")
   public void testExpectedClasses() {