Documentation: various minor improvements

... collected along the way.
PHPCSStandards · Jul 20, 2024 · d60022e · d60022e
1 parent 85318b7
commit d60022e
Show file tree

Hide file tree

Showing 6 changed files with 8 additions and 6 deletions.
diff --git a/src/Reporter.php b/src/Reporter.php
@@ -364,7 +364,7 @@ public function prepareFileReport(File $phpcsFile)
         ];
 
         if ($report['errors'] === 0 && $report['warnings'] === 0) {
-            // Prefect score!
+            // Perfect score!
             return $report;
         }
 

diff --git a/src/Standards/Generic/Sniffs/WhiteSpace/LanguageConstructSpacingSniff.php b/src/Standards/Generic/Sniffs/WhiteSpace/LanguageConstructSpacingSniff.php
@@ -81,7 +81,7 @@ public function process(File $phpcsFile, $stackPtr)
             && strtolower($content) !== 'yield from'
         ) {
             if ($tokens[($stackPtr - 1)]['code'] === T_YIELD_FROM) {
-                // A multi-line statements that has already been processed.
+                // A multi-line statement that has already been processed.
                 return;
             }
 

diff --git a/src/Standards/Squiz/Tests/Scope/MemberVarScopeUnitTest.php b/src/Standards/Squiz/Tests/Scope/MemberVarScopeUnitTest.php
@@ -54,6 +54,7 @@ public function getErrorList()
      */
     public function getWarningList()
     {
+        // Warning from getMemberProperties() about parse error.
         return [71 => 1];
 
     }//end getWarningList()

diff --git a/src/Standards/Zend/Tests/NamingConventions/ValidVariableNameUnitTest.php b/src/Standards/Zend/Tests/NamingConventions/ValidVariableNameUnitTest.php
@@ -92,6 +92,7 @@ public function getWarningList()
             79  => 1,
             82  => 1,
             94  => 1,
+            // Warning from getMemberProperties() about parse error.
             107 => 1,
         ];
 

diff --git a/tests/Core/Util/Common/StripColorsTest.php b/tests/Core/Util/Common/StripColorsTest.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * Tests for the \PHP_CodeSniffer\Util\Sniffs\Common::stripColors() method.
+ * Tests for the \PHP_CodeSniffer\Util\Common::stripColors() method.
  *
  * @author    Juliette Reinders Folmer <phpcs_nospam@adviesenzo.nl>
  * @copyright 2024 Juliette Reinders Folmer. All rights reserved.
@@ -13,7 +13,7 @@
 use PHPUnit\Framework\TestCase;
 
 /**
- * Tests for the \PHP_CodeSniffer\Util\Sniffs\Common::stripColors() method.
+ * Tests for the \PHP_CodeSniffer\Util\Common::stripColors() method.
  *
  * @covers \PHP_CodeSniffer\Util\Common::stripColors
  */

diff --git a/tests/Core/Util/Common/SuggestTypeTest.php b/tests/Core/Util/Common/SuggestTypeTest.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * Tests for the \PHP_CodeSniffer\Util\Sniffs\Common::suggestType() method.
+ * Tests for the \PHP_CodeSniffer\Util\Common::suggestType() method.
  *
  * @author    Juliette Reinders Folmer <phpcs_nospam@adviesenzo.nl>
  * @copyright 2019 Juliette Reinders Folmer. All rights reserved.
@@ -13,7 +13,7 @@
 use PHPUnit\Framework\TestCase;
 
 /**
- * Tests for the \PHP_CodeSniffer\Util\Sniffs\Common::suggestType() method.
+ * Tests for the \PHP_CodeSniffer\Util\Common::suggestType() method.
  *
  * @covers \PHP_CodeSniffer\Util\Common::suggestType
  */