Changeset 47122 for trunk/tests/phpunit/tests/feed/atom.php

Timestamp:

01/29/2020 12:43:23 AM (6 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/feed/atom.php (modified) (9 diffs)

trunk/tests/phpunit/tests/feed/atom.php

@@ -18 +18 @@
      */
     public static function wpSetUpBeforeClass( $factory ) {
-        // Create a user
+        // Create a user.
         self::$user_id = $factory->user->create(
             array(
@@ -27 +27 @@
         );
 
-        // Create a taxonomy
+        // Create a taxonomy.
         self::$category = self::factory()->category->create_and_get(
             array(
@@ -37 +37 @@
         $count = get_option( 'posts_per_rss' ) + 1;
 
-        // Create a few posts
+        // Create a few posts.
         self::$posts = $factory->post->create_many(
             $count,
@@ -47 +47 @@
         );
 
-        // Assign a category to those posts
+        // Assign a category to those posts.
         foreach ( self::$posts as $post ) {
             wp_set_object_terms( $post, self::$category->slug, 'category' );
@@ -141 +141 @@
         $this->assertCount( $this->post_count, $entries );
 
-        // We Really only need to test X number of entries unless the content is different
+        // We really only need to test X number of entries unless the content is different.
         $entries = array_slice( $entries, 1 );
 
@@ -147 +147 @@
         foreach ( $entries as $key => $entry ) {
 
-            // Get post for comparison
+            // Get post for comparison.
             $id = xml_find( $entries[ $key ]['child'], 'id' );
             preg_match( '/\?p=(\d+)/', $id[0]['content'], $matches );
             $post = get_post( $matches[1] );
 
-            // Author
+            // Author.
             $author = xml_find( $entries[ $key ]['child'], 'author', 'name' );
             $user   = new WP_User( $post->post_author );
             $this->assertEquals( $user->display_name, $author[0]['content'] );
 
-            // Title
+            // Title.
             $title = xml_find( $entries[ $key ]['child'], 'title' );
             $this->assertEquals( $post->post_title, $title[0]['content'] );
 
-            // Link rel="alternate"
+            // Link rel="alternate".
             $link_alts = xml_find( $entries[ $key ]['child'], 'link' );
             foreach ( $link_alts as $link_alt ) {
@@ -169 +169 @@
             }
 
-            // Id
+            // ID.
             $guid = xml_find( $entries[ $key ]['child'], 'id' );
             $this->assertEquals( $post->guid, $id[0]['content'] );
 
-            // Updated
+            // Updated.
             $updated = xml_find( $entries[ $key ]['child'], 'updated' );
             $this->assertEquals( strtotime( $post->post_modified_gmt ), strtotime( $updated[0]['content'] ) );
 
-            // Published
+            // Published.
             $published = xml_find( $entries[ $key ]['child'], 'published' );
             $this->assertEquals( strtotime( $post->post_date_gmt ), strtotime( $published[0]['content'] ) );
 
-            // Category
+            // Category.
             foreach ( get_the_category( $post->ID ) as $term ) {
                 $terms[] = $term->name;
@@ -191 +191 @@
             unset( $terms );
 
-            // Content
+            // Content.
             if ( ! $this->excerpt_only ) {
                 $content = xml_find( $entries[ $key ]['child'], 'content' );
@@ -197 +197 @@
             }
 
-            // Link rel="replies"
+            // Link rel="replies".
             $link_replies = xml_find( $entries[ $key ]['child'], 'link' );
             foreach ( $link_replies as $link_reply ) {