Merge pull request #754 from TimothyBJacobs/patch-2

Correctly type REST API Test Case docs
lucatume · Sep 10, 2024 · 5528232 · 5528232
2 parents 145e234 + abafba0
commit 5528232
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 5 deletions.
diff --git a/config/patches/core-phpunit/includes/testcase-rest-api.php.patch b/config/patches/core-phpunit/includes/testcase-rest-api.php.patch
@@ -1,5 +1,5 @@
 diff --git a/includes/core-phpunit/includes/testcase-rest-api.php b/includes/core-phpunit/includes/testcase-rest-api.php
-index 27349809..2107abfc 100644
+index 99dd5e30..e9005563 100644
 --- a/includes/core-phpunit/includes/testcase-rest-api.php
 +++ b/includes/core-phpunit/includes/testcase-rest-api.php
 @@ -1,6 +1,8 @@
@@ -12,3 +12,18 @@ index 27349809..2107abfc 100644
 
  	/**
  	 * Asserts that the REST API response has the specified error.
+@@ -8,10 +10,10 @@ abstract class WP_Test_REST_TestCase extends WP_UnitTestCase {
+ 	 * @since 4.4.0
+ 	 * @since 6.6.0 Added the `$message` parameter.
+ 	 *
+-	 * @param string|int                $code     Expected error code.
+-	 * @param WP_REST_Response|WP_Error $response REST API response.
+-	 * @param int                       $status   Optional. Status code.
+-	 * @param string                    $message  Optional. Message to display when the assertion fails.
++	 * @param string|int                  $code     Expected error code.
++	 * @param \WP_REST_Response|\WP_Error $response REST API response.
++	 * @param int                         $status   Optional. Status code.
++	 * @param string                      $message  Optional. Message to display when the assertion fails.
+ 	 */
+ 	protected function assertErrorResponse( $code, $response, $status = null, $message = '' ) {
+
diff --git a/includes/core-phpunit/includes/testcase-rest-api.php b/includes/core-phpunit/includes/testcase-rest-api.php
@@ -10,10 +10,10 @@ abstract class WPRestApiTestCase extends WPTestCase {
 	 * @since 4.4.0
 	 * @since 6.6.0 Added the `$message` parameter.
 	 *
-	 * @param string|int                $code     Expected error code.
-	 * @param WP_REST_Response|WP_Error $response REST API response.
-	 * @param int                       $status   Optional. Status code.
-	 * @param string                    $message  Optional. Message to display when the assertion fails.
+	 * @param string|int                  $code     Expected error code.
+	 * @param \WP_REST_Response|\WP_Error $response REST API response.
+	 * @param int                         $status   Optional. Status code.
+	 * @param string                      $message  Optional. Message to display when the assertion fails.
 	 */
 	protected function assertErrorResponse( $code, $response, $status = null, $message = '' ) {