Docs: improve consistency and specificity [3]

jrfnl · jrfnl · commit 02b07facd042 · 2024-11-08T12:00:48.000+01:00
This fixes up the `@return` type declarations for all `AbstractVariableRestrictionsSniff::getGroups()` methods.
diff --git a/WordPressVIPMinimum/Sniffs/AbstractVariableRestrictionsSniff.php b/WordPressVIPMinimum/Sniffs/AbstractVariableRestrictionsSniff.php
@@ -91,7 +91,7 @@ public function register() {
 	 *  )
 	 * )
 	 *
-	 * @return array
+	 * @return array<string, array<string, string|array<string>>>
 	 */
 	abstract public function getGroups();
 
diff --git a/WordPressVIPMinimum/Sniffs/Variables/RestrictedVariablesSniff.php b/WordPressVIPMinimum/Sniffs/Variables/RestrictedVariablesSniff.php
@@ -31,7 +31,7 @@ class RestrictedVariablesSniff extends AbstractVariableRestrictionsSniff {
 	 *  )
 	 * )
 	 *
-	 * @return array
+	 * @return array<string, array<string, string|array<string>>>
 	 */
 	public function getGroups() {
 		return [

Original file line number	Diff line number	Diff line change
`@@ -91,7 +91,7 @@ public function register() {`
`91`	`91`	`* )`
`92`	`92`	`* )`
`93`	`93`	`*`
`94`		`- * @return array`
	`94`	`+ * @return array<string, array<string, string\|array<string>>>`
`95`	`95`	`*/`
`96`	`96`	`abstract public function getGroups();`
`97`	`97`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ class RestrictedVariablesSniff extends AbstractVariableRestrictionsSniff {`
`31`	`31`	`* )`
`32`	`32`	`* )`
`33`	`33`	`*`
`34`		`- * @return array`
	`34`	`+ * @return array<string, array<string, string\|array<string>>>`
`35`	`35`	`*/`
`36`	`36`	`public function getGroups() {`
`37`	`37`	`return [`