Use placeholder in message

claudiu-cristea · claudiu-cristea · commit 5e400396be7c · 2024-09-28T21:14:18.000+02:00
diff --git a/coder_sniffer/Drupal/Sniffs/Commenting/FunctionCommentSniff.php b/coder_sniffer/Drupal/Sniffs/Commenting/FunctionCommentSniff.php
@@ -112,7 +112,7 @@ public function process(File $phpcsFile, $stackPtr)
             }
         } else if (in_array($methodName, $this->commentProhibitedFunctions, true) === true) {
             // Method prohibited to have docblock.
-            $fix = $phpcsFile->addFixableError("It's forbidden to document $methodName function", $stackPtr, 'DocProhibited');
+            $fix = $phpcsFile->addFixableError("It's forbidden to document %s function", $stackPtr, 'ForbiddenFunction', [$methodName]);
             if ($fix === true) {
                 for ($i = $tokens[$commentEnd]['comment_opener']; $i <= $commentEnd; $i++) {
                     $phpcsFile->fixer->replaceToken($i, '');

Original file line number	Diff line number	Diff line change
`@@ -112,7 +112,7 @@ public function process(File $phpcsFile, $stackPtr)`
`112`	`112`	`}`
`113`	`113`	`} else if (in_array($methodName, $this->commentProhibitedFunctions, true) === true) {`
`114`	`114`	`// Method prohibited to have docblock.`
`115`		`- $fix = $phpcsFile->addFixableError("It's forbidden to document $methodName function", $stackPtr, 'DocProhibited');`
	`115`	`+ $fix = $phpcsFile->addFixableError("It's forbidden to document %s function", $stackPtr, 'ForbiddenFunction', [$methodName]);`
`116`	`116`	`if ($fix === true) {`
`117`	`117`	`for ($i = $tokens[$commentEnd]['comment_opener']; $i <= $commentEnd; $i++) {`
`118`	`118`	`$phpcsFile->fixer->replaceToken($i, '');`