Rules metadata update (#1466)

Author: joke1196

pom.xml

@@ -93,7 +93,7 @@
     <sonar.version>9.7.1.62043</sonar.version>
     <sonar.orchestrator.version>3.40.0.183</sonar.orchestrator.version>
     <sonar.api.version>9.11.0.290</sonar.api.version>
-    <sonar-analyzer-commons.version>2.4.0.1317</sonar-analyzer-commons.version>
+    <sonar-analyzer-commons.version>2.5.0.1358</sonar-analyzer-commons.version>
     <sonarlint-core.version>8.14.0.63103</sonarlint-core.version>
     <sslr.version>1.23</sslr.version>
     <protobuf.version>3.21.7</protobuf.version>

python-checks/src/main/resources/org/sonar/l10n/py/rules/python/BackticksUsage.html

@@ -1,9 +1,10 @@
+<h2>Why is this an issue?</h2>
 <p>Backticks are a deprecated alias for <code>repr()</code>. Don’t use them any more, the syntax was removed in Python 3.0.</p>
-<h2>Noncompliant Code Example</h2>
+<h3>Noncompliant code example</h3>
 <pre>
 return `num`  # Noncompliant
 </pre>
-<h2>Compliant Solution</h2>
+<h3>Compliant solution</h3>
 <pre>
 return repr(num)
 </pre>

python-checks/src/main/resources/org/sonar/l10n/py/rules/python/ClassComplexity.html

@@ -1,5 +1,5 @@
+<p>This rule is deprecated, and will eventually be removed.</p>
+<h2>Why is this an issue?</h2>
 <p>The cyclomatic complexity of a class should not exceed a defined threshold. Complex code can perform poorly and will in any case be difficult to
 understand and therefore to maintain.</p>
-<h2>Deprecated</h2>
-<p>This rule is deprecated, and will eventually be removed.</p>
 

python-checks/src/main/resources/org/sonar/l10n/py/rules/python/CommentRegularExpression.html

@@ -1,3 +1,4 @@
+<h2>Why is this an issue?</h2>
 <p>This rule template can be used to create rules which will be triggered when a comment matches a given regular expression.</p>
 <p>For example, one can create a rule with the regular expression <code>.*REVIEW.*</code> to match all comment containing "REVIEW".</p>
 <p>Note that, in order to match REVIEW regardless of the case, the <code>(?i)</code> modifier should be prepended to the expression, as in

python-checks/src/main/resources/org/sonar/l10n/py/rules/python/ExecStatementUsage.html

@@ -1,10 +1,11 @@
+<h2>Why is this an issue?</h2>
 <p>Use of the <code>exec</code> statement could be dangerous, and should be avoided. Moreover, the <code>exec</code> statement was removed in Python
 3.0. Instead, the built-in <code>exec()</code> function can be used.</p>
-<h2>Noncompliant Code Example</h2>
+<h3>Noncompliant code example</h3>
 <pre>
 exec 'print 1' # Noncompliant
 </pre>
-<h2>Compliant Solution</h2>
+<h3>Compliant solution</h3>
 <pre>
 exec('print 1')
 </pre>

python-checks/src/main/resources/org/sonar/l10n/py/rules/python/FileComplexity.html

@@ -1,4 +1,4 @@
-<p>Most of the time, a very complex file breaks the Single Responsibility Principle and should be re-factored into several different files.</p>
-<h2>Deprecated</h2>
 <p>This rule is deprecated, and will eventually be removed.</p>
+<h2>Why is this an issue?</h2>
+<p>Most of the time, a very complex file breaks the Single Responsibility Principle and should be re-factored into several different files.</p>
 

python-checks/src/main/resources/org/sonar/l10n/py/rules/python/FunctionComplexity.html

@@ -1,3 +1,4 @@
+<h2>Why is this an issue?</h2>
 <p>The Cyclomatic Complexity of functions should not exceed a defined threshold. Complex code may perform poorly and can be difficult to test
 thoroughly.</p>
 

python-checks/src/main/resources/org/sonar/l10n/py/rules/python/InequalityUsage.html

@@ -1,9 +1,10 @@
+<h2>Why is this an issue?</h2>
 <p>The forms <code>&lt;&gt;</code> and <code>!=</code> are equivalent. But in Python 2.7.3 the <code>&lt;&gt;</code> form is considered obsolete.</p>
-<h2>Noncompliant Code Example</h2>
+<h3>Noncompliant code example</h3>
 <pre>
 return a &lt;&gt; b # Noncompliant
 </pre>
-<h2>Compliant Solution</h2>
+<h3>Compliant solution</h3>
 <pre>
 return a != b
 </pre>

python-checks/src/main/resources/org/sonar/l10n/py/rules/python/LineLength.html

@@ -1,2 +1,3 @@
+<h2>Why is this an issue?</h2>
 <p>Having to scroll horizontally makes it harder to get a quick overview and understanding of any piece of code.</p>
 

python-checks/src/main/resources/org/sonar/l10n/py/rules/python/LongIntegerWithLowercaseSuffixUsage.html

@@ -1,9 +1,10 @@
+<h2>Why is this an issue?</h2>
 <p>The long suffix should always be written in uppercase, i.e. 'L', as the lowercase 'l' can easily be confused with the digit one '1'.</p>
-<h2>Noncompliant Code Example</h2>
+<h3>Noncompliant code example</h3>
 <pre>
 return 10l  // Noncompliant; easily confused with one zero one
 </pre>
-<h2>Compliant Solution</h2>
+<h3>Compliant solution</h3>
 <pre>
 return 10L
 </pre>