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

trunk/tests/phpunit/tests/url.php

@@ -1 +1 @@
 <?php
 
-// tests for link-template.php and related URL functions
 /**
+ * Tests for link-template.php and related URL functions.
+ *
  * @group url
  */
@@ -201 +202 @@
         $screen = get_current_screen();
 
-        // Pretend to be in the site admin
+        // Pretend to be in the site admin.
         set_current_screen( 'dashboard' );
         $home = get_option( 'home' );
 
-        // home_url() should return http when in the admin
+        // home_url() should return http when in the admin.
         $_SERVER['HTTPS'] = 'on';
         $this->assertEquals( $home, home_url() );
@@ -212 +213 @@
         $this->assertEquals( $home, home_url() );
 
-        // If not in the admin, is_ssl() should determine the scheme
+        // If not in the admin, is_ssl() should determine the scheme.
         set_current_screen( 'front' );
         $this->assertEquals( $home, home_url() );
@@ -219 +220 @@
         $this->assertEquals( $home, home_url() );
 
-        // Test with https in home
+        // Test with https in home.
         update_option( 'home', set_url_scheme( $home, 'https' ) );
 
-        // Pretend to be in the site admin
+        // Pretend to be in the site admin.
         set_current_screen( 'dashboard' );
         $home = get_option( 'home' );
 
-        // home_url() should return whatever scheme is set in the home option when in the admin
+        // home_url() should return whatever scheme is set in the home option when in the admin.
         $_SERVER['HTTPS'] = 'on';
         $this->assertEquals( $home, home_url() );
@@ -233 +234 @@
         $this->assertEquals( $home, home_url() );
 
-        // If not in the admin, is_ssl() should determine the scheme unless https hard-coded in home
+        // If not in the admin, is_ssl() should determine the scheme unless https hard-coded in home.
         set_current_screen( 'front' );
         $this->assertEquals( $home, home_url() );
@@ -249 +250 @@
         $screen = get_current_screen();
 
-        // Pretend to be in the site admin
+        // Pretend to be in the site admin.
         set_current_screen( 'dashboard' );
         $home = network_home_url();
 
-        // home_url() should return http when in the admin
+        // home_url() should return http when in the admin.
         $this->assertEquals( 0, strpos( $home, 'http://' ) );
         $_SERVER['HTTPS'] = 'on';
@@ -261 +262 @@
         $this->assertEquals( $home, network_home_url() );
 
-        // If not in the admin, is_ssl() should determine the scheme
+        // If not in the admin, is_ssl() should determine the scheme.
         set_current_screen( 'front' );
         $this->assertEquals( $home, network_home_url() );
@@ -350 +351 @@
         $this->assertEquals( $post_id, $p->ID );
 
-        // The same again to make sure a cached query returns the same result
+        // The same again to make sure a cached query returns the same result.
         $p = get_adjacent_post();
         $this->assertInstanceOf( 'WP_Post', $p );
         $this->assertEquals( $post_id, $p->ID );
 
-        // Test next
+        // Test next.
         $p = get_adjacent_post( false, '', false );
         $this->assertEquals( '', $p );