Changeset 47122 for trunk/tests/phpunit/tests/http/functions.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/http/functions.php (modified) (8 diffs)

trunk/tests/phpunit/tests/http/functions.php

@@ -16 +16 @@
 
     function test_head_request() {
-        // this url give a direct 200 response
+        // This URL gives a direct 200 response.
         $url      = 'https://asdftestblog1.files.wordpress.com/2007/09/2007-06-30-dsc_4700-1.jpg';
         $response = wp_remote_head( $url );
@@ -32 +32 @@
 
     function test_head_redirect() {
-        // this url will 301 redirect
+        // This URL will 301 redirect.
         $url      = 'https://asdftestblog1.wordpress.com/files/2007/09/2007-06-30-dsc_4700-1.jpg';
         $response = wp_remote_head( $url );
@@ -59 +59 @@
         $this->assertInternalType( 'array', $response );
 
-        // should return the same headers as a head request
+        // Should return the same headers as a HEAD request.
         $this->assertEquals( 'image/jpeg', $headers['content-type'] );
         $this->assertEquals( '40148', $headers['content-length'] );
@@ -66 +66 @@
 
     function test_get_redirect() {
-        // this will redirect to asdftestblog1.files.wordpress.com
+        // This will redirect to asdftestblog1.files.wordpress.com.
         $url = 'https://asdftestblog1.wordpress.com/files/2007/09/2007-06-30-dsc_4700-1.jpg';
 
@@ -75 +75 @@
         $headers = wp_remote_retrieve_headers( $response );
 
-        // should return the same headers as a head request
+        // Should return the same headers as a HEAD request.
         $this->assertEquals( 'image/jpeg', $headers['content-type'] );
         $this->assertEquals( '40148', $headers['content-length'] );
@@ -82 +82 @@
 
     function test_get_redirect_limit_exceeded() {
-        // this will redirect to asdftestblog1.files.wordpress.com
+        // This will redirect to asdftestblog1.files.wordpress.com.
         $url = 'https://asdftestblog1.wordpress.com/files/2007/09/2007-06-30-dsc_4700-1.jpg';
 
-        // pretend we've already redirected 5 times
+        // Pretend we've already redirected 5 times.
         $response = wp_remote_get( $url, array( 'redirection' => -1 ) );
 
@@ -184 +184 @@
      */
     function test_get_cookie_host_only() {
-        // emulate WP_Http::request() internals
+        // Emulate WP_Http::request() internals.
         $requests_response = new Requests_Response();
 
@@ -195 +195 @@
         $response = $http_response->to_array();
 
-        // check the host_only flag in the resulting WP_Http_Cookie
+        // Check the host_only flag in the resulting WP_Http_Cookie.
         $cookie = wp_remote_retrieve_cookie( $response, 'test' );
         $this->assertEquals( $cookie->domain, 'wordpress.org' );
         $this->assertFalse( $cookie->host_only, 'host-only flag not set' );
 
-        // regurgitate (Requests_Cookie -> WP_Http_Cookie -> Requests_Cookie)
+        // Regurgitate (Requests_Cookie -> WP_Http_Cookie -> Requests_Cookie).
         $cookies = WP_Http::normalize_cookies( wp_remote_retrieve_cookies( $response ) );
         $this->assertFalse( $cookies['test']->flags['host-only'], 'host-only flag data lost' );