Merge pull request #338 from PHPCSStandards/feature/various-docs-tweaks

Various small docs tweaks

Author: jrfnl

.github/CONTRIBUTING.md

@@ -318,7 +318,7 @@ While not strictly required, it is greatly appreciated if you comply with the fo
 * Being wordy in the commit message is not a bad thing.
     It is greatly preferable to have the details about a fix in the commit message over just having those details
     in the PR description.
-    Code hosting platforms comes and go (think: SourceForge, PEAR), commit messages are here to stay, even if the code base
+    Code hosting platforms come and go (think: SourceForge, PEAR), commit messages are here to stay, even if the code base
     would move to another platform at some point in the future.
 * Ensure that the tests (and docs) related to a particular fix are in the same commit.
     It is much harder to track down what a particular code snippet in a test case file was supposed to be testing if the fix

CHANGELOG.md

@@ -449,7 +449,7 @@ Additionally, thanks to [Alexander Turek][@derrabus] for consulting on the repo
 - Fixed bug [#3440] : Squiz.WhiteSpace.MemberVarSpacing false positives when attributes used without docblock
     - Thanks to [Vadim Borodavko][@javer] for the patch
 - Fixed bug [#3448] : PHP 8.1 deprecation notice while generating running time value
-    - Thanks to [Juliette Reinders Folmer][@jrfnl] and Andy Postnikov for the patch
+    - Thanks to [Juliette Reinders Folmer][@jrfnl] and [Andy Postnikov][@andypost] for the patch
 - Fixed bug [#3456] : PSR12.Classes.ClassInstantiation.MissingParentheses false positive using attributes on anonymous class
     - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch
 - Fixed bug [#3460] : Generic.Formatting.MultipleStatementAlignment false positive on closure with parameters
@@ -649,9 +649,9 @@ Additionally, thanks to [Alexander Turek][@derrabus] for consulting on the repo
 - Spaces are now correctly escaped in the paths to external on Windows
     - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch
 - Generic.CodeAnalysis.UnusedFunctionParameter can now be configured to ignore variable usage for specific type hints
-    -- This allows you to suppress warnings for some variables that are not required, but leave warnings for others
-    -- Set the ignoreTypeHints array property to a list of type hints to ignore
-    -- Thanks to [Petr Bugyík][@o5] for the patch
+    - This allows you to suppress warnings for some variables that are not required, but leave warnings for others
+    - Set the ignoreTypeHints array property to a list of type hints to ignore
+    - Thanks to [Petr Bugyík][@o5] for the patch
 - Generic.Formatting.MultipleStatementAlignment can now align statements at the start of the assignment token
     - Previously, the sniff enforced that the values were aligned, even if this meant the assignment tokens were not
     - Now, the sniff can enforce that the assignment tokens are aligned, even if this means the values are not
@@ -5611,6 +5611,7 @@ Additionally, thanks to [Alexander Turek][@derrabus] for consulting on the repo
 [@andrei-propertyguru]: https://github.com/andrei-propertyguru
 [@AndrewDawes]:         https://github.com/AndrewDawes
 [@andygrunwald]:        https://github.com/andygrunwald
+[@andypost]:            https://github.com/andypost
 [@annechko]:            https://github.com/annechko
 [@anomiex]:             https://github.com/anomiex
 [@arnested]:            https://github.com/arnested

README.md

@@ -15,7 +15,7 @@ PHP_CodeSniffer
 </div>
 
 > [!NOTE]
-> This package is the continuation of the now abandoned [PHP_CodeSniffer package which was created by Squizlabs](https://github.com/squizlabs/PHP_CodeSniffer).
+> This package is the official continuation of the now abandoned [PHP_CodeSniffer package which was created by Squizlabs](https://github.com/squizlabs/PHP_CodeSniffer).
 
 ## About
 

tests/Core/Config/ReportWidthTest.php

@@ -265,7 +265,7 @@ public function testReportWidthInputHandling($input, $expected)
     /**
      * Data provider.
      *
-     * @return array
+     * @return array<string, array<string, mixed>>
      */
     public static function dataReportWidthInputHandling()
     {

tests/Core/Filters/AbstractFilterTestCase.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Tests for the \PHP_CodeSniffer\Filters\GitModified class.
+ * Abstract Testcase class for testing Filters.
  *
  * @author    Juliette Reinders Folmer <[email protected]>
  * @copyright 2023 PHPCSStandards Contributors

tests/Core/Tokenizer/DoubleArrowTest.php

@@ -43,7 +43,7 @@ public function testDoubleArrow($testMarker)
      *
      * @see testDoubleArrow()
      *
-     * @return array
+     * @return array<string, array<string>>
      */
     public static function dataDoubleArrow()
     {
@@ -128,7 +128,7 @@ public function testMatchArrow($testMarker)
      *
      * @see testMatchArrow()
      *
-     * @return array
+     * @return array<string, array<string>>
      */
     public static function dataMatchArrow()
     {
@@ -215,7 +215,7 @@ public function testFnArrow($testMarker)
      *
      * @see testFnArrow()
      *
-     * @return array
+     * @return array<string, array<string>>
      */
     public static function dataFnArrow()
     {

tests/Core/Tokenizer/ShortArrayTest.php

@@ -48,7 +48,7 @@ public function testSquareBrackets($testMarker)
      *
      * @see testSquareBrackets()
      *
-     * @return array
+     * @return array<string, array<string>>
      */
     public static function dataSquareBrackets()
     {
@@ -116,7 +116,7 @@ public function testShortArrays($testMarker)
      *
      * @see testShortArrays()
      *
-     * @return array
+     * @return array<string, array<string>>
      */
     public static function dataShortArrays()
     {