Merge pull request #326 from Yoast/JRF/yoastcs-docs-improve-test-retu…

…rn-tags

Docs: improve test `@return` tags

Yoast/Tests/Commenting/CodeCoverageIgnoreDeprecatedUnitTest.php

@@ -16,7 +16,7 @@ final class CodeCoverageIgnoreDeprecatedUnitTest extends AbstractSniffUnitTest {
 	/**
 	 * Returns the lines where errors should occur.
 	 *
-	 * @return array <int line number> => <int number of errors>
+	 * @return array<int, int> Key is the line number, value is the number of expected errors.
 	 */
 	public function getErrorList(): array {
 		return [
@@ -31,7 +31,7 @@ public function getErrorList(): array {
 	/**
 	 * Returns the lines where warnings should occur.
 	 *
-	 * @return array <int line number> => <int number of warnings>
+	 * @return array<int, int> Key is the line number, value is the number of expected warnings.
 	 */
 	public function getWarningList(): array {
 		return [];

Yoast/Tests/Commenting/CoversTagUnitTest.php

@@ -16,7 +16,7 @@ final class CoversTagUnitTest extends AbstractSniffUnitTest {
 	/**
 	 * Returns the lines where errors should occur.
 	 *
-	 * @return array <int line number> => <int number of errors>
+	 * @return array<int, int> Key is the line number, value is the number of expected errors.
 	 */
 	public function getErrorList(): array {
 		return [
@@ -52,7 +52,7 @@ public function getErrorList(): array {
 	/**
 	 * Returns the lines where warnings should occur.
 	 *
-	 * @return array <int line number> => <int number of warnings>
+	 * @return array<int, int> Key is the line number, value is the number of expected warnings.
 	 */
 	public function getWarningList(): array {
 		return [];

Yoast/Tests/Commenting/FileCommentUnitTest.php

@@ -18,7 +18,7 @@ final class FileCommentUnitTest extends AbstractSniffUnitTest {
 	 *
 	 * @param string $testFile The name of the file being tested.
 	 *
-	 * @return array <int line number> => <int number of errors>
+	 * @return array<int, int> Key is the line number, value is the number of expected errors.
 	 */
 	public function getErrorList( string $testFile = '' ): array {
 		switch ( $testFile ) {
@@ -40,7 +40,7 @@ public function getErrorList( string $testFile = '' ): array {
 	 *
 	 * @param string $testFile The name of the file being tested.
 	 *
-	 * @return array <int line number> => <int number of warnings>
+	 * @return array<int, int> Key is the line number, value is the number of expected warnings.
 	 */
 	public function getWarningList( string $testFile = '' ): array {
 		switch ( $testFile ) {

Yoast/Tests/Commenting/TestsHaveCoversTagUnitTest.php

@@ -16,7 +16,7 @@ final class TestsHaveCoversTagUnitTest extends AbstractSniffUnitTest {
 	/**
 	 * Returns the lines where errors should occur.
 	 *
-	 * @return array <int line number> => <int number of errors>
+	 * @return array<int, int> Key is the line number, value is the number of expected errors.
 	 */
 	public function getErrorList(): array {
 		return [
@@ -32,7 +32,7 @@ public function getErrorList(): array {
 	/**
 	 * Returns the lines where warnings should occur.
 	 *
-	 * @return array <int line number> => <int number of warnings>
+	 * @return array<int, int> Key is the line number, value is the number of expected warnings.
 	 */
 	public function getWarningList(): array {
 		return [];

Yoast/Tests/Files/FileNameUnitTest.php

@@ -116,7 +116,7 @@ protected function getTestFiles( $testFileBase ): array {
 	 *
 	 * @param string $testFile The name of the file being tested.
 	 *
-	 * @return array <int line number> => <int number of errors>
+	 * @return array<int, int> Key is the line number, value is the number of expected errors.
 	 */
 	public function getErrorList( string $testFile = '' ): array {
 
@@ -134,7 +134,7 @@ public function getErrorList( string $testFile = '' ): array {
 	 *
 	 * @param string $testFile The name of the file being tested.
 	 *
-	 * @return array <int line number> => <int number of warnings>
+	 * @return array<int, int> Key is the line number, value is the number of expected warnings.
 	 */
 	public function getWarningList( string $testFile = '' ): array {
 		if ( $testFile === 'no-basepath.inc' ) {

Yoast/Tests/Files/TestDoublesUnitTest.php

@@ -53,7 +53,7 @@ protected function getTestFiles( $testFileBase ): array {
 	 *
 	 * @param string $testFile The name of the file being tested.
 	 *
-	 * @return array <int line number> => <int number of errors>
+	 * @return array<int, int> Key is the line number, value is the number of expected errors.
 	 */
 	public function getErrorList( string $testFile = '' ): array {
 
@@ -132,7 +132,7 @@ public function getErrorList( string $testFile = '' ): array {
 	 *
 	 * @param string $testFile The name of the file being tested.
 	 *
-	 * @return array <int line number> => <int number of warnings>
+	 * @return array<int, int> Key is the line number, value is the number of expected warnings.
 	 */
 	public function getWarningList( string $testFile = '' ): array {
 		switch ( $testFile ) {

Yoast/Tests/NamingConventions/NamespaceNameUnitTest.php

@@ -62,7 +62,7 @@ protected function getTestFiles( $testFileBase ): array {
 	 *
 	 * @param string $testFile The name of the file being tested.
 	 *
-	 * @return array <int line number> => <int number of errors>
+	 * @return array<int, int> Key is the line number, value is the number of expected errors.
 	 */
 	public function getErrorList( string $testFile = '' ): array {
 
@@ -171,7 +171,7 @@ public function getErrorList( string $testFile = '' ): array {
 	 *
 	 * @param string $testFile The name of the file being tested.
 	 *
-	 * @return array <int line number> => <int number of warnings>
+	 * @return array<int, int> Key is the line number, value is the number of expected warnings.
 	 */
 	public function getWarningList( string $testFile = '' ): array {
 		switch ( $testFile ) {

Yoast/Tests/NamingConventions/ObjectNameDepthUnitTest.php

@@ -18,7 +18,7 @@ final class ObjectNameDepthUnitTest extends AbstractSniffUnitTest {
 	 *
 	 * @param string $testFile The name of the file being tested.
 	 *
-	 * @return array <int line number> => <int number of errors>
+	 * @return array<int, int> Key is the line number, value is the number of expected errors.
 	 */
 	public function getErrorList( string $testFile = '' ): array {
 
@@ -54,7 +54,7 @@ public function getErrorList( string $testFile = '' ): array {
 	 *
 	 * @param string $testFile The name of the file being tested.
 	 *
-	 * @return array <int line number> => <int number of warnings>
+	 * @return array<int, int> Key is the line number, value is the number of expected warnings.
 	 */
 	public function getWarningList( string $testFile = '' ): array {
 		switch ( $testFile ) {

Yoast/Tests/NamingConventions/ValidHookNameUnitTest.php

@@ -30,7 +30,7 @@ public function setCliValues( $filename, $config ): void {
 	/**
 	 * Returns the lines where errors should occur.
 	 *
-	 * @return array <int line number> => <int number of errors>
+	 * @return array<int, int> Key is the line number, value is the number of expected errors.
 	 */
 	public function getErrorList(): array {
 
@@ -56,7 +56,7 @@ public function getErrorList(): array {
 	/**
 	 * Returns the lines where warnings should occur.
 	 *
-	 * @return array <int line number> => <int number of warnings>
+	 * @return array<int, int> Key is the line number, value is the number of expected warnings.
 	 */
 	public function getWarningList(): array {
 		return [

Yoast/Tests/Tools/BrainMonkeyRaceConditionUnitTest.php

@@ -16,7 +16,7 @@ final class BrainMonkeyRaceConditionUnitTest extends AbstractSniffUnitTest {
 	/**
 	 * Returns the lines where errors should occur.
 	 *
-	 * @return array <int line number> => <int number of errors>
+	 * @return array<int, int> Key is the line number, value is the number of expected errors.
 	 */
 	public function getErrorList(): array {
 		return [
@@ -30,7 +30,7 @@ public function getErrorList(): array {
 	/**
 	 * Returns the lines where warnings should occur.
 	 *
-	 * @return array <int line number> => <int number of warnings>
+	 * @return array<int, int> Key is the line number, value is the number of expected warnings.
 	 */
 	public function getWarningList(): array {
 		return [];

Yoast/Tests/WhiteSpace/FunctionSpacingUnitTest.php

@@ -16,7 +16,7 @@ final class FunctionSpacingUnitTest extends AbstractSniffUnitTest {
 	/**
 	 * Returns the lines where errors should occur.
 	 *
-	 * @return array <int line number> => <int number of errors>
+	 * @return array<int, int> Key is the line number, value is the number of expected errors.
 	 */
 	public function getErrorList(): array {
 		return [
@@ -36,7 +36,7 @@ public function getErrorList(): array {
 	/**
 	 * Returns the lines where warnings should occur.
 	 *
-	 * @return array <int line number> => <int number of warnings>
+	 * @return array<int, int> Key is the line number, value is the number of expected warnings.
 	 */
 	public function getWarningList(): array {
 		return [];

Yoast/Tests/Yoast/AlternativeFunctionsUnitTest.php

@@ -16,7 +16,7 @@ final class AlternativeFunctionsUnitTest extends AbstractSniffUnitTest {
 	/**
 	 * Returns the lines where errors should occur.
 	 *
-	 * @return array <int line number> => <int number of errors>
+	 * @return array<int, int> Key is the line number, value is the number of expected errors.
 	 */
 	public function getErrorList(): array {
 		return [
@@ -33,7 +33,7 @@ public function getErrorList(): array {
 	/**
 	 * Returns the lines where warnings should occur.
 	 *
-	 * @return array <int line number> => <int number of warnings>
+	 * @return array<int, int> Key is the line number, value is the number of expected warnings.
 	 */
 	public function getWarningList(): array {
 		return [];