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

trunk/tests/phpunit/tests/ajax/Attachments.php

@@ -1 +1 @@
 <?php
 /**
- * Admin ajax functions to be tested
+ * Admin Ajax functions to be tested.
  */
 require_once( ABSPATH . 'wp-admin/includes/ajax-actions.php' );
 
 /**
- * Testing ajax attachment handling.
+ * Testing Ajax attachment handling.
  *
  * @group ajax
@@ -15 +15 @@
      */
     public function test_wp_ajax_send_attachment_to_editor_should_return_an_image() {
-        // Become an administrator
+        // Become an administrator.
         $post    = $_POST;
         $user_id = self::factory()->user->create(
@@ -33 +33 @@
         $attachment = $this->_make_attachment( $upload );
 
-        // Set up a default request
+        // Set up a default request.
         $_POST['nonce']      = wp_create_nonce( 'media-send-to-editor' );
         $_POST['html']       = 'Bar Baz';
@@ -45 +45 @@
         );
 
-        // Make the request
+        // Make the request.
         try {
             $this->_handleAjax( 'send-attachment-to-editor' );
@@ -57 +57 @@
         $expected = get_image_send_to_editor( $attachment, '', '', 'left', 'http://example.com/', false, 'large', 'Foo bar' );
 
-        // Ensure everything is correct
+        // Ensure everything is correct.
         $this->assertTrue( $response['success'] );
         $this->assertEquals( $expected, $response['data'] );
@@ -66 +66 @@
      */
     public function test_wp_ajax_send_attachment_to_editor_should_return_a_link() {
-        // Become an administrator
+        // Become an administrator.
         $post    = $_POST;
         $user_id = self::factory()->user->create(
@@ -84 +84 @@
         $attachment = $this->_make_attachment( $upload );
 
-        // Set up a default request
+        // Set up a default request.
         $_POST['nonce']      = wp_create_nonce( 'media-send-to-editor' );
         $_POST['html']       = 'Bar Baz';
@@ -94 +94 @@
         );
 
-        // Make the request
+        // Make the request.
         try {
             $this->_handleAjax( 'send-attachment-to-editor' );
@@ -110 +110 @@
         );
 
-        // Ensure everything is correct
+        // Ensure everything is correct.
         $this->assertTrue( $response['success'] );
         $this->assertEquals( $expected, $response['data'] );