improved doc comment of test helper

haruncpi · haruncpi · commit be680ac93df1 · 2025-11-10T12:48:18.000+06:00
diff --git a/tests/phpunit/tests/user.php b/tests/phpunit/tests/user.php
@@ -2158,11 +2158,11 @@ public function test_send_confirmation_on_profile_email_html_entities_decoded()
 	}
 
 	/**
-	 * Check array is a sequential.
+	 * Determines whether an array has sequential numeric keys.
 	 *
-	 * @param array $arr array.
+	 * @param array $arr The array to check.
 	 *
-	 * @return bool
+	 * @return bool True if the array has sequential numeric keys, false otherwise.
 	 */
 	private function is_sequential( array $arr ) {
 		return array_keys( $arr ) === range( 0, count( $arr ) - 1 );

Original file line number	Diff line number	Diff line change
`@@ -2158,11 +2158,11 @@ public function test_send_confirmation_on_profile_email_html_entities_decoded()`
`2158`	`2158`	`}`
`2159`	`2159`
`2160`	`2160`	`/**`
`2161`		`- * Check array is a sequential.`
	`2161`	`+ * Determines whether an array has sequential numeric keys.`
`2162`	`2162`	`*`
`2163`		`- * @param array $arr array.`
	`2163`	`+ * @param array $arr The array to check.`
`2164`	`2164`	`*`
`2165`		`- * @return bool`
	`2165`	`+ * @return bool True if the array has sequential numeric keys, false otherwise.`
`2166`	`2166`	`*/`
`2167`	`2167`	`private function is_sequential( array $arr ) {`
`2168`	`2168`	`return array_keys( $arr ) === range( 0, count( $arr ) - 1 );`