Changeset 47122 for trunk/tests/phpunit/includes/testcase-rest-post-type-controller.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/testcase-rest-post-type-controller.php (modified) (9 diffs)

trunk/tests/phpunit/includes/testcase-rest-post-type-controller.php

@@ -6 +6 @@
         $post_type_obj = get_post_type_object( $post->post_type );
 
-        // Standard fields
+        // Standard fields.
         $this->assertEquals( $post->ID, $data['id'] );
         $this->assertEquals( $post->post_name, $data['slug'] );
@@ -26 +26 @@
         $this->assertEquals( mysql_to_rfc3339( $post->post_modified ), $data['modified'] );
 
-        // author
+        // Author.
         if ( post_type_supports( $post->post_type, 'author' ) ) {
             $this->assertEquals( $post->post_author, $data['author'] );
@@ -33 +33 @@
         }
 
-        // post_parent
+        // Post parent.
         if ( $post_type_obj->hierarchical ) {
             $this->assertArrayHasKey( 'parent', $data );
@@ -50 +50 @@
         }
 
-        // page attributes
+        // Page attributes.
         if ( $post_type_obj->hierarchical && post_type_supports( $post->post_type, 'page-attributes' ) ) {
             $this->assertEquals( $post->menu_order, $data['menu_order'] );
@@ -57 +57 @@
         }
 
-        // Comments
+        // Comments.
         if ( post_type_supports( $post->post_type, 'comments' ) ) {
             $this->assertEquals( $post->comment_status, $data['comment_status'] );
@@ -111 +111 @@
 
         if ( post_type_supports( $post->post_type, 'editor' ) ) {
-            // TODO: apply content filter for more accurate testing.
+            // TODO: Apply content filter for more accurate testing.
             if ( ! $post->post_password ) {
                 $this->assertEquals( wpautop( $post->post_content ), $data['content']['rendered'] );
@@ -127 +127 @@
         if ( post_type_supports( $post->post_type, 'excerpt' ) ) {
             if ( empty( $post->post_password ) ) {
-                // TODO: apply excerpt filter for more accurate testing.
+                // TODO: Apply excerpt filter for more accurate testing.
                 $this->assertEquals( wpautop( $post->post_excerpt ), $data['excerpt']['rendered'] );
             } else {
-                // TODO: better testing for excerpts for password protected posts.
+                // TODO: Better testing for excerpts for password protected posts.
             }
             if ( 'edit' === $context ) {
@@ -157 +157 @@
         }
 
-        // test links
+        // Test links.
         if ( $links ) {
 
@@ -212 +212 @@
         foreach ( $all_data as $data ) {
             $post = get_post( $data['id'] );
-            // as the links for the post are "response_links" format in the data array we have to pull them
-            // out and parse them.
+            // As the links for the post are "response_links" format in the data array,
+            // we have to pull them out and parse them.
             $links = $data['_links'];
             foreach ( $links as &$links_array ) {