Changeset 50913

Timestamp:

05/14/2021 07:07:47 PM (3 years ago)

Author:

SergeyBiryukov

Message:

Docs: Update documentation in phpunit/includes/abstract-testcase.php per the documentation standards.

Follow-up to [44902].

See #52628.

File:

• trunk/tests/phpunit/includes/abstract-testcase.php (modified) (16 diffs)

trunk/tests/phpunit/includes/abstract-testcase.php

@@ -139 +139 @@
 
     /**
-     * After a test method runs, reset any state in WordPress the test method might have changed.
+     * After a test method runs, resets any state in WordPress the test method might have changed.
      */
     public function tearDown() {
@@ -180 +180 @@
 
     /**
-     * Allow tests to be skipped on some automated runs.
+     * Allows tests to be skipped on some automated runs.
      *
      * For test runs on GitHub Actions for something other than trunk/master,
@@ -201 +201 @@
 
     /**
-     * Allow tests to be skipped when Multisite is not in use.
+     * Allows tests to be skipped when Multisite is not in use.
      *
      * Use in conjunction with the ms-required group.
@@ -212 +212 @@
 
     /**
-     * Allow tests to be skipped when Multisite is in use.
+     * Allows tests to be skipped when Multisite is in use.
      *
      * Use in conjunction with the ms-excluded group.
@@ -223 +223 @@
 
     /**
-     * Allow tests to be skipped if the HTTP request times out.
+     * Allows tests to be skipped if the HTTP request times out.
      *
      * @param array|WP_Error $response HTTP response.
@@ -246 +246 @@
 
     /**
-     * Unregister existing post types and register defaults.
+     * Unregisters existing post types and register defaults.
      *
      * Run before each test in order to clean up the global scope, in case
@@ -262 +262 @@
 
     /**
-     * Unregister existing taxonomies and register defaults.
+     * Unregisters existing taxonomies and register defaults.
      *
      * Run before each test in order to clean up the global scope, in case
@@ -276 +276 @@
 
     /**
-     * Unregister non-built-in post statuses.
+     * Unregisters non-built-in post statuses.
      */
     protected function reset_post_statuses() {
@@ -285 +285 @@
 
     /**
-     * Reset `$_SERVER` variables
+     * Resets `$_SERVER` variables
      */
     protected function reset__SERVER() {
@@ -353 +353 @@
 
     /**
-     * Clean up any registered meta keys.
+     * Cleans up any registered meta keys.
      *
      * @since 5.1.0
@@ -385 +385 @@
 
     /**
-     * Commit the queries in a transaction.
+     * Commits the queries in a transaction.
      *
      * @since 4.1.0
@@ -510 +510 @@
 
     /**
-     * Detect post-test failure conditions.
+     * Detects post-test failure conditions.
      *
      * We use this method to detect expectedDeprecated and expectedIncorrectUsage annotations.
@@ -521 +521 @@
 
     /**
-     * Declare an expected `_deprecated_function()` or `_deprecated_argument()` call from within a test.
+     * Declares an expected `_deprecated_function()` or `_deprecated_argument()` call from within a test.
      *
      * @since 4.2.0
@@ -533 +533 @@
 
     /**
-     * Declare an expected `_doing_it_wrong()` call from within a test.
+     * Declares an expected `_doing_it_wrong()` call from within a test.
      *
      * @since 4.2.0
@@ -627 +627 @@
      */
     public function assertNotIXRError( $actual, $message = '' ) {
-        if ( $actual instanceof IXR_Error && '' === $message ) {
+        if ( '' === $message && $actual instanceof IXR_Error ) {
             $message = $actual->message;
         }
@@ -1156 +1156 @@
 
     /**
-     * Retrieves all directories contained inside a directory and stores them in the `$matched_dirs` property. Hidden
-     * directories are ignored.
+     * Retrieves all directories contained inside a directory and stores them in the `$matched_dirs` property.
+     * Hidden directories are ignored.
      *
      * This is a helper for the `delete_folders()` method.