Merge pull request #341 from jenkinsci/metric-help

[JENKINS-75323] Fix wrong documentation of metrics selection in column and quality gate
jenkinsci · Feb 25, 2025 · c5ff3c4 · c5ff3c4
2 parents 97266a0 + 8723423
commit c5ff3c4
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 14 deletions.
diff --git a/...resources/io/jenkins/plugins/coverage/metrics/steps/CoverageMetricColumn/help-metric.html b/...resources/io/jenkins/plugins/coverage/metrics/steps/CoverageMetricColumn/help-metric.html
@@ -28,13 +28,19 @@
         <dd>Function call coverage (given as percentage)</dd>
         <dt>TEST_STRENGTH</dt>
         <dd>Test Strength (given as percentage)</dd>
-        <dt>COMPLEXITY</dt>
+        <dt>CYCLOMATIC_COMPLEXITY</dt>
         <dd>Cyclomatic complexity (given as absolute number)</dd>
-        <dt>COMPLEXITY_DENSITY</dt>
-        <dd>Cyclomatic complexity density (given as relation between cyclomatic complexity and lines of code)</dd>
-        <dt>COMPLEXITY_MAXIMUM</dt>
-        <dd>Maximum cyclomatic complexity of all methods (given as absolute number)</dd>
+        <dt>COGNITIVE_COMPLEXITY</dt>
+        <dd>Cognitive complexity (given as absolute number)</dd>
+        <dt>NPATH_COMPLEXITY</dt>
+        <dd>N-Path complexity (given as absolute number)</dd>
         <dt>LOC</dt>
         <dd>Lines of code (given as absolute number)</dd>
+        <dt>NCSS</dt>
+        <dd>Non Commenting Source Statements (given as absolute number)</dd>
+        <dt>COHESION</dt>
+        <dd>Class cohesion (given as percentage)</dd>
+        <dt>WEIGHT_OF_CLASS</dt>
+        <dd>Weight of a class (given as percentage)</dd>
     </dl>
 </div>
diff --git a/.../resources/io/jenkins/plugins/coverage/metrics/steps/CoverageQualityGate/help-metric.html b/.../resources/io/jenkins/plugins/coverage/metrics/steps/CoverageQualityGate/help-metric.html
@@ -7,7 +7,7 @@
         <dt>MODULE</dt>
         <dd>Covered and missed modules (given as percentage)</dd>
         <dt>PACKAGE</dt>
-        <dd>Covered and missed packages; also used for namespaces or directories (given as percentage)</dd>
+        <dd>Covered and missed packages - also used for namespaces or directories (given as percentage)</dd>
         <dt>FILE</dt>
         <dd>Covered and missed files (given as percentage)</dd>
         <dt>CLASS</dt>
@@ -25,18 +25,22 @@
         <dt>MCDC_PAIR</dt>
         <dd>MC/DC Pair coverage (given as percentage)</dd>
         <dt>FUNCTION_CALL</dt>
-        <dd>Function call coverage(given as percentage)</dd>
+        <dd>Function call coverage (given as percentage)</dd>
         <dt>TEST_STRENGTH</dt>
         <dd>Test Strength (given as percentage)</dd>
-        <dt>COMPLEXITY</dt>
+        <dt>CYCLOMATIC_COMPLEXITY</dt>
         <dd>Cyclomatic complexity (given as absolute number)</dd>
-        <dt>COMPLEXITY_DENSITY</dt>
-        <dd>Cyclomatic complexity density (given as relation between cyclomatic complexity and lines of code)</dd>
-        <dt>COMPLEXITY_MAXIMUM</dt>
-        <dd>Maximum cyclomatic complexity of all methods (given as absolute number)</dd>
+        <dt>COGNITIVE_COMPLEXITY</dt>
+        <dd>Cognitive complexity (given as absolute number)</dd>
+        <dt>NPATH_COMPLEXITY</dt>
+        <dd>N-Path complexity (given as absolute number)</dd>
         <dt>LOC</dt>
         <dd>Lines of code (given as absolute number)</dd>
-        <dt>TESTS</dt>
-        <dd>Number of tests (given as absolute number)</dd>
+        <dt>NCSS</dt>
+        <dd>Non Commenting Source Statements (given as absolute number)</dd>
+        <dt>COHESION</dt>
+        <dd>Class cohesion (given as percentage)</dd>
+        <dt>WEIGHT_OF_CLASS</dt>
+        <dd>Weight of a class (given as percentage)</dd>
     </dl>
 </div>