Changeset 47122 for trunk/tests/phpunit/tests/post/query.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/post/query.php (modified) (9 diffs)

trunk/tests/phpunit/tests/post/query.php

@@ -96 +96 @@
         );
 
-        // Fourth post added in filter
+        // Fourth post added in filter.
         $this->assertEquals( 4, count( $query->posts ) );
         $this->assertEquals( 4, $query->post_count );
@@ -102 +102 @@
         foreach ( $query->posts as $post ) {
 
-            // posts are WP_Post objects
+            // Posts are WP_Post objects.
             $this->assertTrue( is_a( $post, 'WP_Post' ) );
 
-            // filters are raw
+            // Filters are raw.
             $this->assertEquals( 'raw', $post->filter );
 
-            // custom data added in the_posts filter is preserved
+            // Custom data added in the_posts filter is preserved.
             $this->assertEquals( array( $post->ID, 'custom data' ), $post->custom_data );
         }
@@ -409 +409 @@
      */
     function test_orderby() {
-        // 'rand' is a valid value
+        // 'rand' is a valid value.
         $q = new WP_Query( array( 'orderby' => 'rand' ) );
         $this->assertContains( 'ORDER BY RAND()', $q->request );
@@ -415 +415 @@
         $this->assertNotContains( 'DESC', $q->request );
 
-        // This isn't allowed
+        // This isn't allowed.
         $q2 = new WP_Query( array( 'order' => 'rand' ) );
         $this->assertContains( 'ORDER BY', $q2->request );
@@ -421 +421 @@
         $this->assertContains( 'DESC', $q2->request );
 
-        // 'none' is a valid value
+        // 'none' is a valid value.
         $q3 = new WP_Query( array( 'orderby' => 'none' ) );
         $this->assertNotContains( 'ORDER BY', $q3->request );
@@ -427 +427 @@
         $this->assertNotContains( 'ASC', $q3->request );
 
-        // false is a valid value
+        // False is a valid value.
         $q4 = new WP_Query( array( 'orderby' => false ) );
         $this->assertNotContains( 'ORDER BY', $q4->request );
@@ -433 +433 @@
         $this->assertNotContains( 'ASC', $q4->request );
 
-        // empty array() is a valid value
+        // Empty array() is a valid value.
         $q5 = new WP_Query( array( 'orderby' => array() ) );
         $this->assertNotContains( 'ORDER BY', $q5->request );
@@ -567 +567 @@
         $this->post_id = self::factory()->post->create();
 
-        // Prevent the DB query
+        // Prevent the DB query.
         add_filter( 'posts_request', '__return_empty_string' );
         add_filter( 'found_posts_query', '__return_empty_string' );
 
-        // Add the post and found_posts
+        // Add the post and found_posts.
         add_filter( 'the_posts', array( $this, 'filter_the_posts' ) );
         add_filter( 'found_posts', array( $this, 'filter_found_posts' ) );
@@ -691 +691 @@
 
     public function set_found_posts_provider() {
-        // count return 0 for null, but 1 for other data you may not expect
+        // Count return 0 for null, but 1 for other data you may not expect.
         return array(
             array( null, 0 ),