From 3b4b5647d3a179021b39c40f25fb951c889750c3 Mon Sep 17 00:00:00 2001 From: jrfnl Date: Mon, 18 Sep 2023 05:56:24 +0200 Subject: [PATCH] Docs: improve `register()` method `@return` tags --- Yoast/Sniffs/Commenting/CodeCoverageIgnoreDeprecatedSniff.php | 2 +- Yoast/Sniffs/Commenting/CoversTagSniff.php | 2 +- Yoast/Sniffs/Commenting/TestsHaveCoversTagSniff.php | 2 +- Yoast/Sniffs/Files/FileNameSniff.php | 2 +- Yoast/Sniffs/Files/TestDoublesSniff.php | 2 +- Yoast/Sniffs/NamingConventions/NamespaceNameSniff.php | 2 +- Yoast/Sniffs/NamingConventions/ObjectNameDepthSniff.php | 2 +- Yoast/Sniffs/Tools/BrainMonkeyRaceConditionSniff.php | 2 +- 8 files changed, 8 insertions(+), 8 deletions(-) diff --git a/Yoast/Sniffs/Commenting/CodeCoverageIgnoreDeprecatedSniff.php b/Yoast/Sniffs/Commenting/CodeCoverageIgnoreDeprecatedSniff.php index 3b63360f..3e28cc82 100644 --- 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 */ public function register() { return [ diff --git a/Yoast/Sniffs/Commenting/CoversTagSniff.php b/Yoast/Sniffs/Commenting/CoversTagSniff.php index fd1e4a4d..f51c94bf 100644 --- 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 */ public function register() { return [ diff --git a/Yoast/Sniffs/Commenting/TestsHaveCoversTagSniff.php b/Yoast/Sniffs/Commenting/TestsHaveCoversTagSniff.php index 462b8dde..4c3e84a3 100644 --- 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 */ public function register() { return [ diff --git a/Yoast/Sniffs/Files/FileNameSniff.php b/Yoast/Sniffs/Files/FileNameSniff.php index 79f920a0..f3d145e4 100644 --- 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 */ public function register() { return [ \T_OPEN_TAG ]; diff --git a/Yoast/Sniffs/Files/TestDoublesSniff.php b/Yoast/Sniffs/Files/TestDoublesSniff.php index 93ddd394..d3d7156c 100644 --- 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 */ public function register() { return [ diff --git a/Yoast/Sniffs/NamingConventions/NamespaceNameSniff.php b/Yoast/Sniffs/NamingConventions/NamespaceNameSniff.php index 5568b447..afc974ff 100644 --- 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 */ public function register() { return [ \T_NAMESPACE ]; diff --git a/Yoast/Sniffs/NamingConventions/ObjectNameDepthSniff.php b/Yoast/Sniffs/NamingConventions/ObjectNameDepthSniff.php index 5a481aee..acfaf307 100644 --- 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 */ public function register() { return [ diff --git a/Yoast/Sniffs/Tools/BrainMonkeyRaceConditionSniff.php b/Yoast/Sniffs/Tools/BrainMonkeyRaceConditionSniff.php index 0a733801..57e02283 100644 --- 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 */ public function register() { return [ \T_STRING ];