Changeset 53542 for trunk/tests/phpunit/tests/image/functions.php

Timestamp:

06/20/2022 10:24:03 PM (3 years ago)

Author:

SergeyBiryukov

Message:

Docs: Use third-person singular verbs for function descriptions in Tests_Image_Functions, per the documentation standards.

See #55646.

File:

• trunk/tests/phpunit/tests/image/functions.php (modified) (13 diffs)

trunk/tests/phpunit/tests/image/functions.php

@@ -9 +9 @@
 
     /**
-     * Setup test fixture
+     * Includes the required files.
      */
     public function set_up() {
@@ -29 +29 @@
 
     /**
-     * Get the available image editor engine classes.
+     * Gets the available image editor engine classes.
      *
      * @return string[] Available image editor classes; empty array when none are available.
@@ -56 +56 @@
 
     /**
-     * Get the MIME type of a file
+     * Gets the MIME type of a file.
      *
      * @param string $filename
@@ -250 +250 @@
 
     /**
-     * Test wp_save_image_file() and mime types.
+     * Tests wp_save_image_file() and mime types.
      *
      * @dataProvider data_wp_save_image_file
@@ -329 +329 @@
 
     /**
-     * Test that a passed mime type overrides the extension in the filename when saving an image.
+     * Tests that a passed mime type overrides the extension in the filename when saving an image.
      *
      * @dataProvider data_image_editor_engine_classes
@@ -363 +363 @@
 
     /**
-     * Test that mime types are correctly inferred from file extensions when saving an image.
+     * Tests that mime types are correctly inferred from file extensions when saving an image.
      *
      * @dataProvider data_inferred_mime_types_when_saving_an_image
@@ -442 +442 @@
 
     /**
-     * Test that the deprecated wp_load_image() function fails when loading a directory.
+     * Tests that the deprecated wp_load_image() function fails when loading a directory.
      *
      * @ticket 17814
@@ -454 +454 @@
 
     /**
-     * Test that the wp_get_image_editor() function fails when loading a directory.
+     * Tests that the wp_get_image_editor() function fails when loading a directory.
      *
      * @ticket 17814
@@ -465 +465 @@
 
     /**
-     * Test that the load() method in an image editor class fails when loading a directory.
+     * Tests that the load() method in an image editor class fails when loading a directory.
      *
      * @dataProvider data_image_editor_engine_classes
@@ -546 +546 @@
      * @covers ::wp_crop_image
      */
-    public function test_wp_crop_image_should_fail_with_wp_error_object_if_file_does_not_exists() {
+    public function test_wp_crop_image_should_fail_with_wp_error_object_if_file_does_not_exist() {
         $file = wp_crop_image(
             DIR_TESTDATA . '/images/canoladoesnotexist.jpg',
@@ -706 +706 @@
 
     /**
-     * Crop setting for PDF.
+     * Tests crop setting for PDF.
      *
      * @ticket 43226
@@ -847 +847 @@
 
     /**
-     * Test PDF preview doesn't overwrite existing JPEG.
+     * Tests that PDF preview does not overwrite existing JPEG.
      *
      * @ticket 39875
@@ -903 +903 @@
 
     /**
-     * Test for wp_exif_frac2dec verified that it properly handles edge cases
+     * Tests that wp_exif_frac2dec() properly handles edge cases
      * and always returns an int or float, or 0 for failures.
      *