Merge pull request #327 from Yoast/JRF/yoastcs-docs-improve-register-…

…return-tags Docs: improve `register()` method `@return` tags
Yoast · Nov 4, 2023 · 06cf5d2 · 06cf5d2
2 parents b0964f2 + 3b4b564
commit 06cf5d2
Show file tree

Hide file tree

Showing 8 changed files with 8 additions and 8 deletions.
diff --git a/Yoast/Sniffs/Commenting/CodeCoverageIgnoreDeprecatedSniff.php b/Yoast/Sniffs/Commenting/CodeCoverageIgnoreDeprecatedSniff.php
@@ -17,7 +17,7 @@ final class CodeCoverageIgnoreDeprecatedSniff implements Sniff {
 	/**
 	 * Returns an array of tokens this test wants to listen for.
 	 *
-	 * @return (int|string)[]
+	 * @return array<int|string>
 	 */
 	public function register() {
 		return [

diff --git a/Yoast/Sniffs/Commenting/CoversTagSniff.php b/Yoast/Sniffs/Commenting/CoversTagSniff.php
@@ -38,7 +38,7 @@ final class CoversTagSniff implements Sniff {
 	/**
 	 * Returns an array of tokens this test wants to listen for.
 	 *
-	 * @return (int|string)[]
+	 * @return array<int|string>
 	 */
 	public function register() {
 		return [

diff --git a/Yoast/Sniffs/Commenting/TestsHaveCoversTagSniff.php b/Yoast/Sniffs/Commenting/TestsHaveCoversTagSniff.php
@@ -18,7 +18,7 @@ final class TestsHaveCoversTagSniff implements Sniff {
 	/**
 	 * Returns an array of tokens this test wants to listen for.
 	 *
-	 * @return (int|string)[]
+	 * @return array<int|string>
 	 */
 	public function register() {
 		return [

diff --git a/Yoast/Sniffs/Files/FileNameSniff.php b/Yoast/Sniffs/Files/FileNameSniff.php
@@ -72,7 +72,7 @@ final class FileNameSniff implements Sniff {
 	/**
 	 * Returns an array of tokens this test wants to listen for.
 	 *
-	 * @return (int|string)[]
+	 * @return array<int|string>
 	 */
 	public function register() {
 		return [ \T_OPEN_TAG ];

diff --git a/Yoast/Sniffs/Files/TestDoublesSniff.php b/Yoast/Sniffs/Files/TestDoublesSniff.php
@@ -50,7 +50,7 @@ final class TestDoublesSniff implements Sniff {
 	/**
 	 * Returns an array of tokens this test wants to listen for.
 	 *
-	 * @return (int|string)[]
+	 * @return array<int|string>
 	 */
 	public function register() {
 		return [

diff --git a/Yoast/Sniffs/NamingConventions/NamespaceNameSniff.php b/Yoast/Sniffs/NamingConventions/NamespaceNameSniff.php
@@ -87,7 +87,7 @@ final class NamespaceNameSniff implements Sniff {
 	/**
 	 * Returns an array of tokens this test wants to listen for.
 	 *
-	 * @return (int|string)[]
+	 * @return array<int|string>
 	 */
 	public function register() {
 		return [ \T_NAMESPACE ];

diff --git a/Yoast/Sniffs/NamingConventions/ObjectNameDepthSniff.php b/Yoast/Sniffs/NamingConventions/ObjectNameDepthSniff.php
@@ -60,7 +60,7 @@ final class ObjectNameDepthSniff extends WPCS_Sniff {
 	/**
 	 * Returns an array of tokens this test wants to listen for.
 	 *
-	 * @return (int|string)[]
+	 * @return array<int|string>
 	 */
 	public function register() {
 		return [

diff --git a/Yoast/Sniffs/Tools/BrainMonkeyRaceConditionSniff.php b/Yoast/Sniffs/Tools/BrainMonkeyRaceConditionSniff.php
@@ -20,7 +20,7 @@ final class BrainMonkeyRaceConditionSniff extends Sniff {
 	/**
 	 * Returns an array of tokens this test wants to listen for.
 	 *
-	 * @return array
+	 * @return array<int|string>
 	 */
 	public function register() {
 		return [ \T_STRING ];