#1130 - fixed description

yegor256 · Aug 22, 2022 · d03fa3d · d03fa3d
1 parent 3f69fe7
commit d03fa3d
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 4 deletions.
diff --git a/qulice-pmd/src/main/resources/com/qulice/pmd/ruleset.xml b/qulice-pmd/src/main/resources/com/qulice/pmd/ruleset.xml
@@ -219,11 +219,14 @@ OF THE POSSIBILITY OF SUCH DAMAGE.
     </properties>
   </rule>
   <rule name="JUnit5TestShouldBePackagePrivate" language="java" class="net.sourceforge.pmd.lang.rule.XPathRule" message="JUnit 5 tests should be package-private">
-    <description>
+    <description><![CDATA[
       Reports JUnit 5 test classes and methods that are not package-private.
       Contrary to JUnit 4 tests, which required public visibility to be run by the engine,
-      JUnit 5 tests can also be run if they’re package-private.
-      Marking them as such is a good practice to limit their visibility.
+      JUnit 5 tests can also be run if they're package-private. Marking them as such
+      is a good practice to limit their visibility.
+      Test methods are identified as those which use `@Test`, `@RepeatedTest`,
+      `@TestFactory`, `@TestTemplate` or `@ParameterizedTest`.
+    ]]>
     </description>
     <priority>3</priority>
     <properties>

diff --git a/qulice-pmd/src/test/java/com/qulice/pmd/PmdValidatorTest.java b/qulice-pmd/src/test/java/com/qulice/pmd/PmdValidatorTest.java
@@ -616,7 +616,7 @@ public void allowsDuplicateLiteralsInAnnotations() throws Exception {
 
     /**
      * PmdValidator can allow only package private methods,
-     * annotated @Test, @RepeatedTest, @TestFactory, @TestTemplate or @ParameterizedTest.
+     * annotated by @Test, @RepeatedTest, @TestFactory, @TestTemplate or @ParameterizedTest.
      * @throws Exception If something wrong happens inside.
      */
     @Test