Update function comment according to the actual functionality

matiasbenedetto · matiasbenedetto · commit 0a48e09e7835 · 2024-09-09T12:45:50.000-03:00
diff --git a/php/class-wp-cli.php b/php/class-wp-cli.php
@@ -770,7 +770,7 @@ public static function log( $message ) {
 	/**
 	 * Display success message prefixed with "Success: ".
 	 *
-	 * Success message is written to STDOUT.
+	 * Success message is written to STDOUT, or discarded when `--quiet` flag is supplied.
 	 *
 	 * Typically recommended to inform user of successful script conclusion.
 	 *
@@ -850,7 +850,7 @@ public static function debug( $message, $group = false ) {
 	/**
 	 * Display warning message prefixed with "Warning: ".
 	 *
-	 * Warning message is written to STDERR.
+	 * Warning message is written to STDERR, or discarded when `--quiet` flag is supplied.
 	 *
 	 * Use instead of `WP_CLI::debug()` when script execution should be permitted
 	 * to continue.

Original file line number	Diff line number	Diff line change
`@@ -770,7 +770,7 @@ public static function log( $message ) {`
`770`	`770`	`/**`
`771`	`771`	`* Display success message prefixed with "Success: ".`
`772`	`772`	`*`
`773`		`- * Success message is written to STDOUT.`
	`773`	+ * Success message is written to STDOUT, or discarded when `--quiet` flag is supplied.
`774`	`774`	`*`
`775`	`775`	`* Typically recommended to inform user of successful script conclusion.`
`776`	`776`	`*`
`@@ -850,7 +850,7 @@ public static function debug( $message, $group = false ) {`
`850`	`850`	`/**`
`851`	`851`	`* Display warning message prefixed with "Warning: ".`
`852`	`852`	`*`
`853`		`- * Warning message is written to STDERR.`
	`853`	+ * Warning message is written to STDERR, or discarded when `--quiet` flag is supplied.
`854`	`854`	`*`
`855`	`855`	* Use instead of `WP_CLI::debug()` when script execution should be permitted
`856`	`856`	`* to continue.`