Changeset 47122 for trunk/tests/phpunit/tests/formatting/Smilies.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/tests/formatting/Smilies.php (modified) (11 diffs)

trunk/tests/phpunit/tests/formatting/Smilies.php

@@ -50 +50 @@
      */
     function test_convert_standard_smilies( $in_txt, $converted_txt ) {
-        // standard smilies, use_smilies: ON
-        update_option( 'use_smilies', 1 );
-
-        smilies_init();
-
-        $this->assertEquals( $converted_txt, convert_smilies( $in_txt ) );
-
-        // standard smilies, use_smilies: OFF
+        // Standard smilies, use_smilies: ON.
+        update_option( 'use_smilies', 1 );
+
+        smilies_init();
+
+        $this->assertEquals( $converted_txt, convert_smilies( $in_txt ) );
+
+        // Standard smilies, use_smilies: OFF.
         update_option( 'use_smilies', 0 );
 
@@ -95 +95 @@
         global $wpsmiliestrans;
 
-        // custom smilies, use_smilies: ON
+        // Custom smilies, use_smilies: ON.
         update_option( 'use_smilies', 1 );
 
@@ -102 +102 @@
         }
 
-        $trans_orig = $wpsmiliestrans; // save original translations array
+        $trans_orig = $wpsmiliestrans; // Save original translations array.
 
         $wpsmiliestrans = array(
@@ -115 +115 @@
         $this->assertEquals( $converted_txt, convert_smilies( $in_txt ) );
 
-        // standard smilies, use_smilies: OFF
+        // Standard smilies, use_smilies: OFF.
         update_option( 'use_smilies', 0 );
 
         $this->assertEquals( $in_txt, convert_smilies( $in_txt ) );
 
-        $wpsmiliestrans = $trans_orig; // reset original translations array
+        $wpsmiliestrans = $trans_orig; // Reset original translations array.
     }
 
@@ -150 +150 @@
         $exp_str = "Do we ingore smilies \xf0\x9f\x98\x89 in $element tags <$element class=\"foo\">My Content Here :?: </$element>";
 
-        // standard smilies, use_smilies: ON
+        // Standard smilies, use_smilies: ON.
         update_option( 'use_smilies', 1 );
         smilies_init();
@@ -156 +156 @@
         $this->assertEquals( $exp_str, convert_smilies( $in_str ) );
 
-        // standard smilies, use_smilies: OFF
+        // Standard smilies, use_smilies: OFF.
         update_option( 'use_smilies', 0 );
     }
@@ -202 +202 @@
      */
     public function test_smilies_combinations( $in_txt, $converted_txt ) {
-        // custom smilies, use_smilies: ON
-        update_option( 'use_smilies', 1 );
-        smilies_init();
-
-        $this->assertEquals( $converted_txt, convert_smilies( $in_txt ) );
-
-        // custom smilies, use_smilies: OFF
+        // Custom smilies, use_smilies: ON.
+        update_option( 'use_smilies', 1 );
+        smilies_init();
+
+        $this->assertEquals( $converted_txt, convert_smilies( $in_txt ) );
+
+        // Custom smilies, use_smilies: OFF.
         update_option( 'use_smilies', 0 );
 
@@ -246 +246 @@
         global $wpsmiliestrans;
 
-        // standard smilies, use_smilies: ON
+        // Standard smilies, use_smilies: ON.
         update_option( 'use_smilies', 1 );
 
@@ -253 +253 @@
         }
 
-        $orig_trans = $wpsmiliestrans; // save original tranlations array
+        $orig_trans = $wpsmiliestrans; // Save original tranlations array.
 
         $wpsmiliestrans = array(
@@ -263 +263 @@
         $this->assertEquals( $converted_txt, convert_smilies( $in_txt ) );
 
-        // standard smilies, use_smilies: OFF
+        // Standard smilies, use_smilies: OFF.
         update_option( 'use_smilies', 0 );
 
         $this->assertEquals( $in_txt, convert_smilies( $in_txt ) );
 
-        $wpsmiliestrans = $orig_trans; // reset original translations array
+        $wpsmiliestrans = $orig_trans; // Reset original translations array.
     }
 
@@ -301 +301 @@
      */
     function test_spaces_around_smilies( $in_txt, $converted_txt ) {
-        // standard smilies, use_smilies: ON
-        update_option( 'use_smilies', 1 );
-
-        smilies_init();
-
-        $this->assertEquals( $converted_txt, convert_smilies( $in_txt ) );
-
-        // standard smilies, use_smilies: OFF
+        // Standard smilies, use_smilies: ON.
+        update_option( 'use_smilies', 1 );
+
+        smilies_init();
+
+        $this->assertEquals( $converted_txt, convert_smilies( $in_txt ) );
+
+        // Standard smilies, use_smilies: OFF.
         update_option( 'use_smilies', 0 );
     }