Turn off Squiz.Commenting.FunctionCommentThrowTag.WrongNumber PHPCS rule

This rule is generating some false positives. We can try turning it on again if it gets fixed in a later PHPCS version. Alternatively we could start relying on a static code analyser for more robust checks on how we're using exceptions.
Automattic · Apr 1, 2020 · 59ebee2 · 59ebee2
1 parent 49c3cdd
commit 59ebee2
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/phpcs.xml.dist b/phpcs.xml.dist
@@ -16,6 +16,9 @@
 	<!-- Rules -->
 	<rule ref="WooCommerce-Core" >
 		<exclude name="Generic.Commenting.Todo.TaskFound"/>
+
+		<!-- This rule is currently generating some false positives, it would be worth retrying after PHPCS upgrades -->
+        <exclude name="Squiz.Commenting.FunctionCommentThrowTag.WrongNumber"/>
 	</rule>
 
 	<rule ref="WordPress.WP.I18n">