Improve docs for protected method

oschwald · oschwald · commit ecd47120b13c · 2024-11-15T09:06:40.000-08:00
diff --git a/src/MinFraud/ServiceClient.php b/src/MinFraud/ServiceClient.php
@@ -68,8 +68,11 @@ protected function maybeThrowInvalidInputException(string $msg): void
     }
 
     /**
-     * @param array<string, mixed> $array
-     * @param list<string>         $types
+     * @ignore
+     *
+     * @param array<string, mixed> $array the parent array
+     * @param string               $key   the key to remove
+     * @param list<string>         $types the expected types
      */
     protected function remove(array &$array, string $key, array $types = ['string']): mixed
     {

Original file line number	Diff line number	Diff line change
`@@ -68,8 +68,11 @@ protected function maybeThrowInvalidInputException(string $msg): void`
`68`	`68`	`}`
`69`	`69`
`70`	`70`	`/**`
`71`		`- * @param array<string, mixed> $array`
`72`		`- * @param list<string> $types`
	`71`	`+ * @ignore`
	`72`	`+ *`
	`73`	`+ * @param array<string, mixed> $array the parent array`
	`74`	`+ * @param string $key the key to remove`
	`75`	`+ * @param list<string> $types the expected types`
`73`	`76`	`*/`
`74`	`77`	`protected function remove(array &$array, string $key, array $types = ['string']): mixed`
`75`	`78`	`{`