Update Inline comments (#5910)

huzaifaalmesbah · danielbachhuber · web-flow · commit 52751b1d1f8b · 2024-03-03T04:37:25.000-08:00
* Improve Inline comments

* Remove period from PHPCS comment

---------

Co-authored-by: Daniel Bachhuber &lt;daniel.bachhuber@automattic.com&gt;
diff --git a/php/class-wp-cli.php b/php/class-wp-cli.php
@@ -393,14 +393,14 @@ private static function wp_hook_build_unique_id( $tag, $function, $priority ) {
 		}
 
 		if ( is_object( $function ) ) {
-			// Closures are currently implemented as objects
+			// Closures are currently implemented as objects.
 			$function = [ $function, '' ];
 		} else {
 			$function = (array) $function;
 		}
 
 		if ( is_object( $function[0] ) ) {
-			// Object Class Calling
+			// Object Class Calling.
 			if ( function_exists( 'spl_object_hash' ) ) {
 				return spl_object_hash( $function[0] ) . $function[1];
 			}
@@ -421,7 +421,7 @@ private static function wp_hook_build_unique_id( $tag, $function, $priority ) {
 		}
 
 		if ( is_string( $function[0] ) ) {
-			// Static Calling
+			// Static Calling.
 			return $function[0] . '::' . $function[1];
 		}
 	}
@@ -1069,7 +1069,7 @@ public static function error_to_string( $errors ) {
 			return $errors;
 		}
 
-		// Only json_encode() the data when it needs it
+		// Only json_encode() the data when it needs it.
 		$render_data = function ( $data ) {
 			if ( is_array( $data ) || is_object( $data ) ) {
 				return json_encode( $data );
@@ -1457,18 +1457,18 @@ public static function run_command( $args, $assoc_args = [] ) {
 
 
 
-	// DEPRECATED STUFF
+	// DEPRECATED STUFF.
 
 	public static function add_man_dir() {
 		trigger_error( 'WP_CLI::add_man_dir() is deprecated. Add docs inline.', E_USER_WARNING );
 	}
 
-	// back-compat
+	// back-compat.
 	public static function out( $str ) {
 		fwrite( STDOUT, $str );
 	}
 
-	// back-compat
+	// back-compat.
 	// phpcs:ignore WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid -- Deprecated method.
 	public static function addCommand( $name, $class ) {
 		trigger_error(
diff --git a/php/utils.php b/php/utils.php
@@ -220,7 +220,7 @@ function find_file_upward( $files, $dir = null, $stop_check = null ) {
 }
 
 function is_path_absolute( $path ) {
-	// Windows
+	// Windows.
 	if ( isset( $path[1] ) && ':' === $path[1] ) {
 		return true;
 	}
@@ -868,7 +868,7 @@ function get_default_cacert( $halt_on_error = false ) {
 	$error_msg = 'Cannot find SSL certificate.';
 
 	if ( inside_phar( $cert_path ) ) {
-		// cURL can't read Phar archives
+		// cURL can't read Phar archives.
 		return extract_from_phar( $cert_path );
 	}
 
@@ -895,13 +895,13 @@ function get_default_cacert( $halt_on_error = false ) {
  * @return string
  */
 function increment_version( $current_version, $new_version ) {
-	// split version assuming the format is x.y.z-pre
+	// split version assuming the format is x.y.z-pre.
 	$current_version    = explode( '-', $current_version, 2 );
 	$current_version[0] = explode( '.', $current_version[0] );
 
 	switch ( $new_version ) {
 		case 'same':
-			// do nothing
+			// do nothing.
 			break;
 
 		case 'patch':
@@ -925,7 +925,7 @@ function increment_version( $current_version, $new_version ) {
 			$current_version = [ $current_version[0] ]; // Drop possible pre-release info.
 			break;
 
-		default: // not a keyword
+		default: // not a keyword.
 			$current_version = [ [ $new_version ] ];
 			break;
 	}
@@ -1007,7 +1007,7 @@ function get_flag_value( $assoc_args, $flag, $default = null ) {
 function get_home_dir() {
 	$home = getenv( 'HOME' );
 	if ( ! $home ) {
-		// In Windows $HOME may not be defined
+		// In Windows $HOME may not be defined.
 		$home = getenv( 'HOMEDRIVE' ) . getenv( 'HOMEPATH' );
 	}
 
diff --git a/php/wp-settings-cli.php b/php/wp-settings-cli.php
@@ -441,7 +441,7 @@ function get_magic_quotes_gpc() {
  */
 do_action( 'init' );
 
-// Check site status
+// Check site status.
 # if ( is_multisite() ) {  // WP-CLI
 if ( is_multisite() && ! defined( 'WP_INSTALLING' ) ) {
 	$file = ms_site_check();

Original file line number	Diff line number	Diff line change
`@@ -393,14 +393,14 @@ private static function wp_hook_build_unique_id( $tag, $function, $priority ) {`
`393`	`393`	`}`
`394`	`394`
`395`	`395`	`if ( is_object( $function ) ) {`
`396`		`- // Closures are currently implemented as objects`
	`396`	`+ // Closures are currently implemented as objects.`
`397`	`397`	`$function = [ $function, '' ];`
`398`	`398`	`} else {`
`399`	`399`	`$function = (array) $function;`
`400`	`400`	`}`
`401`	`401`
`402`	`402`	`if ( is_object( $function[0] ) ) {`
`403`		`- // Object Class Calling`
	`403`	`+ // Object Class Calling.`
`404`	`404`	`if ( function_exists( 'spl_object_hash' ) ) {`
`405`	`405`	`return spl_object_hash( $function[0] ) . $function[1];`
`406`	`406`	`}`
`@@ -421,7 +421,7 @@ private static function wp_hook_build_unique_id( $tag, $function, $priority ) {`
`421`	`421`	`}`
`422`	`422`
`423`	`423`	`if ( is_string( $function[0] ) ) {`
`424`		`- // Static Calling`
	`424`	`+ // Static Calling.`
`425`	`425`	`return $function[0] . '::' . $function[1];`
`426`	`426`	`}`
`427`	`427`	`}`
`@@ -1069,7 +1069,7 @@ public static function error_to_string( $errors ) {`
`1069`	`1069`	`return $errors;`
`1070`	`1070`	`}`
`1071`	`1071`
`1072`		`- // Only json_encode() the data when it needs it`
	`1072`	`+ // Only json_encode() the data when it needs it.`
`1073`	`1073`	`$render_data = function ( $data ) {`
`1074`	`1074`	`if ( is_array( $data ) \|\| is_object( $data ) ) {`
`1075`	`1075`	`return json_encode( $data );`
`@@ -1457,18 +1457,18 @@ public static function run_command( $args, $assoc_args = [] ) {`
`1457`	`1457`
`1458`	`1458`
`1459`	`1459`
`1460`		`- // DEPRECATED STUFF`
	`1460`	`+ // DEPRECATED STUFF.`
`1461`	`1461`
`1462`	`1462`	`public static function add_man_dir() {`
`1463`	`1463`	`trigger_error( 'WP_CLI::add_man_dir() is deprecated. Add docs inline.', E_USER_WARNING );`
`1464`	`1464`	`}`
`1465`	`1465`
`1466`		`- // back-compat`
	`1466`	`+ // back-compat.`
`1467`	`1467`	`public static function out( $str ) {`
`1468`	`1468`	`fwrite( STDOUT, $str );`
`1469`	`1469`	`}`
`1470`	`1470`
`1471`		`- // back-compat`
	`1471`	`+ // back-compat.`
`1472`	`1472`	`// phpcs:ignore WordPress.NamingConventions.ValidFunctionName.MethodNameInvalid -- Deprecated method.`
`1473`	`1473`	`public static function addCommand( $name, $class ) {`
`1474`	`1474`	`trigger_error(`