Changeset 47122 for trunk/tests/phpunit/tests/mail.php

Timestamp:

01/29/2020 12:43:23 AM (5 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/mail.php (modified) (4 diffs)

trunk/tests/phpunit/tests/mail.php

@@ -102 +102 @@
         wp_mail( $to, $subject, $message, $headers );
 
-        // WordPress 3.2 and later correctly split the address into the two parts and send them seperately to PHPMailer
+        // WordPress 3.2 and later correctly split the address into the two parts and send them separately to PHPMailer.
         // Earlier versions of PHPMailer were not touchy about the formatting of these arguments.
 
-        //retrieve the mailer instance
+        // Retrieve the mailer instance.
         $mailer = tests_retrieve_phpmailer_instance();
         $this->assertEquals( 'address@tld.com', $mailer->get_recipient( 'to' )->address );
@@ -126 +126 @@
         wp_mail( $to, $subject, $message );
 
-        // WordPress 3.2 and later correctly split the address into the two parts and send them seperately to PHPMailer
+        // WordPress 3.2 and later correctly split the address into the two parts and send them separately to PHPMailer.
         // Earlier versions of PHPMailer were not touchy about the formatting of these arguments.
         $mailer = tests_retrieve_phpmailer_instance();
@@ -168 +168 @@
      */
     function test_wp_mail_return_value() {
-        // No errors
+        // No errors.
         $this->assertTrue( wp_mail( 'valid@address.com', 'subject', 'body' ) );
 
-        // Non-fatal errors
+        // Non-fatal errors.
         $this->assertTrue( wp_mail( 'valid@address.com', 'subject', 'body', "Cc: invalid-address\nBcc: @invalid.address", ABSPATH . '/non-existant-file.html' ) );
 
-        // Fatal errors
+        // Fatal errors.
         $this->assertFalse( wp_mail( 'invalid.address', 'subject', 'body', '', array() ) );
     }
@@ -401 +401 @@
         );
 
-        //Retrieve the arguments passed to the 'wp_mail_failed' hook callbacks
+        // Retrieve the arguments passed to the 'wp_mail_failed' hook callbacks.
         $all_args  = $ma->get_args();
         $call_args = array_pop( $all_args );