From 6768039f21bd91ff302363cf44582405dcb2209b Mon Sep 17 00:00:00 2001 From: Sergey Biryukov Date: Fri, 14 May 2021 19:07:47 +0000 Subject: [PATCH] Docs: Update documentation in `phpunit/includes/abstract-testcase.php` per the documentation standards. Follow-up to [44902]. See #52628. git-svn-id: https://develop.svn.wordpress.org/trunk@50913 602fd350-edb4-49c9-b593-d223f7449a82 --- tests/phpunit/includes/abstract-testcase.php | 34 ++++++++++---------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/tests/phpunit/includes/abstract-testcase.php b/tests/phpunit/includes/abstract-testcase.php index 886725addd..3af8e39351 100644 --- a/tests/phpunit/includes/abstract-testcase.php +++ b/tests/phpunit/includes/abstract-testcase.php @@ -138,7 +138,7 @@ abstract class WP_UnitTestCase_Base extends PHPUnit\Framework\TestCase { } /** - * 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() { global $wpdb, $wp_query, $wp; @@ -179,7 +179,7 @@ abstract class WP_UnitTestCase_Base extends PHPUnit\Framework\TestCase { } /** - * 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, * we want to skip tests that only need to run for master. @@ -200,7 +200,7 @@ abstract class WP_UnitTestCase_Base extends PHPUnit\Framework\TestCase { } /** - * 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. */ @@ -211,7 +211,7 @@ abstract class WP_UnitTestCase_Base extends PHPUnit\Framework\TestCase { } /** - * 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. */ @@ -222,7 +222,7 @@ abstract class WP_UnitTestCase_Base extends PHPUnit\Framework\TestCase { } /** - * 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. */ @@ -245,7 +245,7 @@ abstract class WP_UnitTestCase_Base extends PHPUnit\Framework\TestCase { } /** - * 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 * a test forgets to unregister a post type on its own, or fails before @@ -261,7 +261,7 @@ abstract class WP_UnitTestCase_Base extends PHPUnit\Framework\TestCase { } /** - * 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 * a test forgets to unregister a taxonomy on its own, or fails before @@ -275,7 +275,7 @@ abstract class WP_UnitTestCase_Base extends PHPUnit\Framework\TestCase { } /** - * Unregister non-built-in post statuses. + * Unregisters non-built-in post statuses. */ protected function reset_post_statuses() { foreach ( get_post_stati( array( '_builtin' => false ) ) as $post_status ) { @@ -284,7 +284,7 @@ abstract class WP_UnitTestCase_Base extends PHPUnit\Framework\TestCase { } /** - * Reset `$_SERVER` variables + * Resets `$_SERVER` variables */ protected function reset__SERVER() { tests_reset__SERVER(); @@ -352,7 +352,7 @@ abstract class WP_UnitTestCase_Base extends PHPUnit\Framework\TestCase { } /** - * Clean up any registered meta keys. + * Cleans up any registered meta keys. * * @since 5.1.0 * @@ -384,7 +384,7 @@ abstract class WP_UnitTestCase_Base extends PHPUnit\Framework\TestCase { } /** - * Commit the queries in a transaction. + * Commits the queries in a transaction. * * @since 4.1.0 */ @@ -509,7 +509,7 @@ abstract class WP_UnitTestCase_Base extends PHPUnit\Framework\TestCase { } /** - * Detect post-test failure conditions. + * Detects post-test failure conditions. * * We use this method to detect expectedDeprecated and expectedIncorrectUsage annotations. * @@ -520,7 +520,7 @@ abstract class WP_UnitTestCase_Base extends PHPUnit\Framework\TestCase { } /** - * 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 * @@ -532,7 +532,7 @@ abstract class WP_UnitTestCase_Base extends PHPUnit\Framework\TestCase { } /** - * 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 * @@ -626,7 +626,7 @@ abstract class WP_UnitTestCase_Base extends PHPUnit\Framework\TestCase { * @param string $message Optional. Message to display when the assertion fails. */ public function assertNotIXRError( $actual, $message = '' ) { - if ( $actual instanceof IXR_Error && '' === $message ) { + if ( '' === $message && $actual instanceof IXR_Error ) { $message = $actual->message; } $this->assertNotInstanceOf( 'IXR_Error', $actual, $message ); @@ -1155,8 +1155,8 @@ abstract class WP_UnitTestCase_Base extends PHPUnit\Framework\TestCase { } /** - * 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. *