Changeset 47122 for trunk/tests/phpunit/tests/rest-api/rest-tags-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-tags-controller.php (modified) (6 diffs)

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

@@ -132 +132 @@
 
         public function test_context_param() {
-                // Collection
+                // Collection.
                 $request  = new WP_REST_Request( 'OPTIONS', '/wp/v2/tags' );
                 $response = rest_get_server()->dispatch( $request );
@@ -138 +138 @@
                 $this->assertEquals( 'view', $data['endpoints'][0]['args']['context']['default'] );
                 $this->assertEqualSets( array( 'view', 'embed', 'edit' ), $data['endpoints'][0]['args']['context']['enum'] );
-                // Single
+                // Single.
                 $tag1     = $this->factory->tag->create( array( 'name' => 'Season 5' ) );
                 $request  = new WP_REST_Request( 'OPTIONS', '/wp/v2/tags/' . $tag1 );
@@ -888 +888 @@
                 $request->set_param( 'slug', $term->slug );
 
-                // Run twice to make sure that the update still succeeds even if no DB
-                // rows are updated.
+                // Run twice to make sure that the update still succeeds
+                // even if no DB rows are updated.
                 $response = rest_get_server()->dispatch( $request );
                 $this->assertEquals( 200, $response->get_status() );
@@ -981 +981 @@
 
         public function verify_tag_roundtrip( $input = array(), $expected_output = array() ) {
-                // Create the tag
+                // Create the tag.
                 $request = new WP_REST_Request( 'POST', '/wp/v2/tags' );
                 foreach ( $input as $name => $value ) {
@@ -990 +990 @@
                 $actual_output = $response->get_data();
 
-                // Compare expected API output to actual API output
+                // Compare expected API output to actual API output.
                 $this->assertEquals( $expected_output['name'], $actual_output['name'] );
                 $this->assertEquals( $expected_output['description'], $actual_output['description'] );
 
-                // Compare expected API output to WP internal values
+                // Compare expected API output to WP internal values.
                 $tag = get_term_by( 'id', $actual_output['id'], 'post_tag' );
                 $this->assertEquals( $expected_output['name'], $tag->name );
                 $this->assertEquals( $expected_output['description'], $tag->description );
 
-                // Update the tag
+                // Update the tag.
                 $request = new WP_REST_Request( 'PUT', sprintf( '/wp/v2/tags/%d', $actual_output['id'] ) );
                 foreach ( $input as $name => $value ) {
@@ -1008 +1008 @@
                 $actual_output = $response->get_data();
 
-                // Compare expected API output to actual API output
+                // Compare expected API output to actual API output.
                 $this->assertEquals( $expected_output['name'], $actual_output['name'] );
                 $this->assertEquals( $expected_output['description'], $actual_output['description'] );
 
-                // Compare expected API output to WP internal values
+                // Compare expected API output to WP internal values.
                 $tag = get_term_by( 'id', $actual_output['id'], 'post_tag' );
                 $this->assertEquals( $expected_output['name'], $tag->name );