Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: improve register() method @return tags #327

Merged
merged 1 commit into from
Nov 4, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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 [
Expand Down
2 changes: 1 addition & 1 deletion Yoast/Sniffs/Commenting/CoversTagSniff.php
Original file line number Diff line number Diff line change
Expand Up @@ -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 [
Expand Down
2 changes: 1 addition & 1 deletion Yoast/Sniffs/Commenting/TestsHaveCoversTagSniff.php
Original file line number Diff line number Diff line change
Expand Up @@ -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 [
Expand Down
2 changes: 1 addition & 1 deletion Yoast/Sniffs/Files/FileNameSniff.php
Original file line number Diff line number Diff line change
Expand Up @@ -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 ];
Expand Down
2 changes: 1 addition & 1 deletion Yoast/Sniffs/Files/TestDoublesSniff.php
Original file line number Diff line number Diff line change
Expand Up @@ -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 [
Expand Down
2 changes: 1 addition & 1 deletion Yoast/Sniffs/NamingConventions/NamespaceNameSniff.php
Original file line number Diff line number Diff line change
Expand Up @@ -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 ];
Expand Down
2 changes: 1 addition & 1 deletion Yoast/Sniffs/NamingConventions/ObjectNameDepthSniff.php
Original file line number Diff line number Diff line change
Expand Up @@ -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 [
Expand Down
2 changes: 1 addition & 1 deletion Yoast/Sniffs/Tools/BrainMonkeyRaceConditionSniff.php
Original file line number Diff line number Diff line change
Expand Up @@ -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 ];
Expand Down