Changeset 47122 for trunk/tests/phpunit/tests/rest-api/rest-settings-controller.php

Timestamp:

01/29/2020 12:43:23 AM (7 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/rest-api/rest-settings-controller.php (modified) (5 diffs)

trunk/tests/phpunit/tests/rest-api/rest-settings-controller.php

@@ -105 +105 @@
         public function test_get_item_value_is_cast_to_type() {
                 wp_set_current_user( self::$administrator );
-                update_option( 'posts_per_page', 'invalid_number' ); // this is cast to (int) 1
+                update_option( 'posts_per_page', 'invalid_number' ); // This is cast to (int) 1.
                 $request  = new WP_REST_Request( 'GET', '/wp/v2/settings' );
                 $response = rest_get_server()->dispatch( $request );
@@ -183 +183 @@
                 $this->assertEquals( array(), $data['mycustomsetting'] );
 
-                // Invalid value
+                // Invalid value.
                 update_option( 'mycustomsetting', array( array( 1 ) ) );
                 $request  = new WP_REST_Request( 'GET', '/wp/v2/settings' );
@@ -190 +190 @@
                 $this->assertEquals( null, $data['mycustomsetting'] );
 
-                // No option value
+                // No option value.
                 delete_option( 'mycustomsetting' );
                 $request  = new WP_REST_Request( 'GET', '/wp/v2/settings' );
@@ -239 +239 @@
                 $this->assertEquals( array(), $data['mycustomsetting'] );
 
-                // Invalid value
+                // Invalid value.
                 update_option(
                         'mycustomsetting',
@@ -380 +380 @@
         public function update_setting_custom_callback( $result, $name, $value, $args ) {
                 if ( 'title' === $name && 'The new title!' === $value ) {
-                        // Do not allow changing the title in this case
+                        // Do not allow changing the title in this case.
                         return true;
                 }