Generic/CamelCapsFunctionName: update code comment

rodrigoprimo · rodrigoprimo · commit 55c6faff7fa6 · 2024-10-24T16:30:37.000-03:00
The original inline comment was inaccurate as code removes all leading
underscores and not just the first.
diff --git a/src/Standards/Generic/Sniffs/NamingConventions/CamelCapsFunctionNameSniff.php b/src/Standards/Generic/Sniffs/NamingConventions/CamelCapsFunctionNameSniff.php
@@ -149,7 +149,7 @@ protected function processTokenWithinScope(File $phpcsFile, $stackPtr, $currScop
             return;
         }
 
-        // Ignore first underscore in methods prefixed with "_".
+        // Ignore leading underscores in the method name.
         $methodName = ltrim($methodName, '_');
 
         $methodProps = $phpcsFile->getMethodProperties($stackPtr);

Original file line number	Diff line number	Diff line change
`@@ -149,7 +149,7 @@ protected function processTokenWithinScope(File $phpcsFile, $stackPtr, $currScop`
`149`	`149`	`return;`
`150`	`150`	`}`
`151`	`151`
`152`		`- // Ignore first underscore in methods prefixed with "_".`
	`152`	`+ // Ignore leading underscores in the method name.`
`153`	`153`	`$methodName = ltrim($methodName, '_');`
`154`	`154`
`155`	`155`	`$methodProps = $phpcsFile->getMethodProperties($stackPtr);`