Changeset 47122 for trunk/tests/phpunit/includes/abstract-testcase.php

Timestamp:

01/29/2020 12:43:23 AM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve inline comments per the documentation standards.

Includes minor code layout fixes for better readability.

See #48303.

File:

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

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

@@ -500 +500 @@
         }
 
-        // Perform an assertion, but only if there are expected or unexpected deprecated calls or wrongdoings
+        // Perform an assertion, but only if there are expected or unexpected deprecated calls or wrongdoings.
         if ( ! empty( $this->expected_deprecated ) ||
             ! empty( $this->expected_doing_it_wrong ) ||
@@ -728 +728 @@
      */
     public function go_to( $url ) {
-        // note: the WP and WP_Query classes like to silently fetch parameters
-        // from all over the place (globals, GET, etc), which makes it tricky
-        // to run them more than once without very carefully clearing everything
+        /*
+         * Note: the WP and WP_Query classes like to silently fetch parameters
+         * from all over the place (globals, GET, etc), which makes it tricky
+         * to run them more than once without very carefully clearing everything.
+         */
         $_GET  = array();
         $_POST = array();
@@ -743 +745 @@
             if ( isset( $parts['query'] ) ) {
                 $req .= '?' . $parts['query'];
-                // parse the url query vars into $_GET
+                // Parse the URL query vars into $_GET.
                 parse_str( $parts['query'], $_GET );
             }
@@ -778 +780 @@
      * This is a custom extension of the PHPUnit requirements handling.
      *
-     * Contains legacy code for skipping tests that are associated with an open Trac ticket. Core tests no longer
-     * support this behaviour.
+     * Contains legacy code for skipping tests that are associated with an open Trac ticket.
+     * Core tests no longer support this behaviour.
      *
      * @since 3.5.0
@@ -806 +808 @@
         }
 
-        // Core tests no longer check against open Trac tickets, but others using WP_UnitTestCase may do so.
+        // Core tests no longer check against open Trac tickets,
+        // but others using WP_UnitTestCase may do so.
         if ( defined( 'WP_RUN_CORE_TESTS' ) && WP_RUN_CORE_TESTS ) {
             return;