Changeset 47122 for trunk/tests/phpunit/tests/option/transient.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/option/transient.php (modified) (2 diffs)

trunk/tests/phpunit/tests/option/transient.php

@@ -94 +94 @@
      */
     function test_nonexistent_key_dont_delete_if_false() {
-        // Create a bogus a transient
+        // Create a bogus a transient.
         $key = 'test_transient';
         set_transient( $key, 'test', 60 * 10 );
         $this->assertEquals( 'test', get_transient( $key ) );
 
-        // Useful variables for tracking
+        // Useful variables for tracking.
         $transient_timeout = '_transient_timeout_' . $key;
 
-        // Mock an action for tracking action calls
+        // Mock an action for tracking action calls.
         $a = new MockAction();
 
-        // Make sure the timeout option returns false
+        // Make sure the timeout option returns false.
         add_filter( 'option_' . $transient_timeout, '__return_false' );
 
-        // Add some actions to make sure options are _not_ deleted
+        // Add some actions to make sure options are _not_ deleted.
         add_action( 'delete_option', array( $a, 'action' ) );
 
-        // Act
+        // Act.
         get_transient( $key );
 
-        // Make sure delete option was not called for both the transient and the timeout
+        // Make sure 'delete_option' was not called for both the transient and the timeout.
         $this->assertEquals( 0, $a->get_call_count() );
     }
@@ -122 +122 @@
      */
     function test_nonexistent_key_old_timeout() {
-        // Create a transient
+        // Create a transient.
         $key = 'test_transient';
         set_transient( $key, 'test', 60 * 10 );
         $this->assertEquals( 'test', get_transient( $key ) );
 
-        // Make sure the timeout option returns false
+        // Make sure the timeout option returns false.
         $timeout          = '_transient_timeout_' . $key;
         $transient_option = '_transient_' . $key;
         add_filter( 'option_' . $timeout, '__return_zero' );
 
-        // Mock an action for tracking action calls
+        // Mock an action for tracking action calls.
         $a = new MockAction();
 
-        // Add some actions to make sure options are deleted
+        // Add some actions to make sure options are deleted.
         add_action( 'delete_option', array( $a, 'action' ) );
 
-        // Act
+        // Act.
         get_transient( $key );
 
-        // Make sure delete option was called for both the transient and the timeout
+        // Make sure 'delete_option' was called for both the transient and the timeout.
         $this->assertEquals( 2, $a->get_call_count() );