Changeset 50491 for trunk

Timestamp:

03/04/2021 10:11:38 AM (4 years ago)

Author:

SergeyBiryukov

Message:

Docs: Update inline comments in some test files per the documentation standards.

See #52628.

Location:

trunk/tests/phpunit/tests

Files:

• formatting/SanitizeFileName.php (modified) (1 diff)
• image/editorGd.php (modified) (5 diffs)
• image/editorImagick.php (modified) (5 diffs)
• rest-api/rest-themes-controller.php (modified) (1 diff)
• sitemaps/functions.php (modified) (3 diffs)
• user/capabilities.php (modified) (5 diffs)

trunk/tests/phpunit/tests/formatting/SanitizeFileName.php

@@ -6 +6 @@
 class Tests_Formatting_SanitizeFileName extends WP_UnitTestCase {
     function test_munges_extensions() {
-        # r17990
+        // r17990
         $file_name = sanitize_file_name( 'test.phtml.txt' );
         $this->assertSame( 'test.phtml_.txt', $file_name );

trunk/tests/phpunit/tests/image/editorGd.php

@@ -90 +90 @@
         $resized = $gd_image_editor->multi_resize( $sizes_array );
 
-        # First, check to see if returned array is as expected
+        // First, check to see if returned array is as expected.
         $expected_array = array(
             array(
@@ -218 +218 @@
              */
             array(
-                'width'  => 9999, # Arbitrary High Value
+                'width'  => 9999, // Arbitrary high value.
                 'height' => 20,
                 'crop'   => false,
@@ -229 +229 @@
             array(
                 'width'  => 45,
-                'height' => 9999, # Arbitrary High Value
+                'height' => 9999, // Arbitrary high value.
                 'crop'   => true,
             ),
@@ -272 +272 @@
              */
             array(
-                'width'  => -9999, # Arbitrary Negative Value
+                'width'  => -9999, // Arbitrary negative value.
                 'height' => 70,
             ),
@@ -282 +282 @@
             array(
                 'width'  => 200,
-                'height' => -9999, # Arbitrary Negative Value
+                'height' => -9999, // Arbitrary negative value.
             ),
         );

trunk/tests/phpunit/tests/image/editorImagick.php

@@ -84 +84 @@
         $resized = $imagick_image_editor->multi_resize( $sizes_array );
 
-        # First, check to see if returned array is as expected
+        // First, check to see if returned array is as expected.
         $expected_array = array(
             array(
@@ -212 +212 @@
              */
             array(
-                'width'  => 9999, # Arbitrary High Value
+                'width'  => 9999, // Arbitrary high value.
                 'height' => 20,
                 'crop'   => false,
@@ -223 +223 @@
             array(
                 'width'  => 45,
-                'height' => 9999, # Arbitrary High Value
+                'height' => 9999, // Arbitrary high value.
                 'crop'   => true,
             ),
@@ -266 +266 @@
              */
             array(
-                'width'  => -9999, # Arbitrary Negative Value
+                'width'  => -9999, // Arbitrary negative value.
                 'height' => 70,
             ),
@@ -276 +276 @@
             array(
                 'width'  => 200,
-                'height' => -9999, # Arbitrary Negative Value
+                'height' => -9999, // Arbitrary negative value.
             ),
         );

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

@@ -1206 +1206 @@
 
     /**
-     * Test single theme
+     * Test single theme.
      *
      * @ticket 50152

trunk/tests/phpunit/tests/sitemaps/functions.php

@@ -102 +102 @@
             array( 'posts', 'page', 1, home_url( '/?sitemap=posts&sitemap-subtype=page&paged=1' ) ),
             array( 'posts', 'page', 5, home_url( '/?sitemap=posts&sitemap-subtype=page&paged=5' ) ),
-            // post_type doesn't exist.
+            // Post type doesn't exist.
             array( 'posts', 'foo', 5, false ),
             array( 'taxonomies', 'category', 1, home_url( '/?sitemap=taxonomies&sitemap-subtype=category&paged=1' ) ),
             array( 'taxonomies', 'post_tag', 1, home_url( '/?sitemap=taxonomies&sitemap-subtype=post_tag&paged=1' ) ),
+            // Negative paged, gets converted to its absolute value.
             array( 'taxonomies', 'post_tag', -1, home_url( '/?sitemap=taxonomies&sitemap-subtype=post_tag&paged=1' ) ),
-            // negative paged, gets converted to it's absolute value.
             array( 'users', '', 4, home_url( '/?sitemap=users&paged=4' ) ),
-            // users provider doesn't allow subtypes.
+            // Users provider doesn't allow subtypes.
             array( 'users', 'foo', 4, false ),
-            // provider doesn't exist.
+            // Provider doesn't exist.
             array( 'foo', '', 4, false ),
         );
@@ -117 +117 @@
 
     /**
-     * Data provider for test_get_sitemap_url_pretty_permalinks
+     * Data provider for test_get_sitemap_url_pretty_permalinks.
      *
      * @return array[] {
@@ -134 +134 @@
             array( 'posts', 'page', 1, home_url( '/wp-sitemap-posts-page-1.xml' ) ),
             array( 'posts', 'page', 5, home_url( '/wp-sitemap-posts-page-5.xml' ) ),
-            // post_type doesn't exist.
+            // Post type doesn't exist.
             array( 'posts', 'foo', 5, false ),
             array( 'taxonomies', 'category', 1, home_url( '/wp-sitemap-taxonomies-category-1.xml' ) ),
             array( 'taxonomies', 'post_tag', 1, home_url( '/wp-sitemap-taxonomies-post_tag-1.xml' ) ),
-            // negative paged, gets converted to it's absolute value.
+            // Negative paged, gets converted to its absolute value.
             array( 'taxonomies', 'post_tag', -1, home_url( '/wp-sitemap-taxonomies-post_tag-1.xml' ) ),
             array( 'users', '', 4, home_url( '/wp-sitemap-users-4.xml' ) ),
-            // users provider doesn't allow subtypes.
+            // Users provider doesn't allow subtypes.
             array( 'users', 'foo', 4, false ),
-            // provider doesn't exist.
+            // Provider doesn't exist.
             array( 'foo', '', 4, false ),
         );

trunk/tests/phpunit/tests/user/capabilities.php

@@ -646 +646 @@
         foreach ( self::$users as $role => $user ) {
 
-            # Test adding the cap directly to the user
+            // Test adding the cap directly to the user.
             $user->add_cap( 'do_not_allow' );
             $has_cap = $user->has_cap( 'do_not_allow' );
@@ -652 +652 @@
             $this->assertFalse( $has_cap, "User with the {$role} role should not have the do_not_allow capability" );
 
-            # Test adding the cap via a filter
+            // Test adding the cap via a filter.
             add_filter( 'user_has_cap', array( $this, 'grant_do_not_allow' ), 10, 4 );
             $has_cap = $user->has_cap( 'do_not_allow' );
@@ -663 +663 @@
             }
 
-            # Test adding the cap to the user's role
+            // Test adding the cap to the user's role.
             $role_obj = get_role( $role );
             $role_obj->add_cap( 'do_not_allow' );
@@ -677 +677 @@
      */
     public function test_do_not_allow_is_denied_for_super_admins() {
-        # Test adding the cap directly to the user
+        // Test adding the cap directly to the user.
         self::$super_admin->add_cap( 'do_not_allow' );
         $has_cap = self::$super_admin->has_cap( 'do_not_allow' );
@@ -683 +683 @@
         $this->assertFalse( $has_cap, 'Super admins should not have the do_not_allow capability' );
 
-        # Test adding the cap via a filter
+        // Test adding the cap via a filter.
         add_filter( 'user_has_cap', array( $this, 'grant_do_not_allow' ), 10, 4 );
         $has_cap = self::$super_admin->has_cap( 'do_not_allow' );