Skip to content

Update log and warning logger functions comment according to the actual functionality #5979

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 5, 2025

Conversation

matiasbenedetto
Copy link
Contributor

What?

Update log and warning logger functions comment according to the actual functionality.

In this PR I'm updating those 2 function comments to state that as the other logging function being muted by the --quiet command. Example:

* Success message is written to STDOUT, or discarded when `--quiet` flag is supplied.

Why?

Both functions log nothing when running wp-cli with --quiet option.

Reference:

/**
* Warning messages aren't logged.
*
* @param string $message Message to write.
*/
public function warning( $message ) {
// Nothing.
}

@schlessera schlessera merged commit c62f232 into wp-cli:main Feb 5, 2025
41 of 42 checks passed
@schlessera schlessera added this to the 2.12.0 milestone Feb 5, 2025
@schlessera
Copy link
Member

Thanks for the PR, @matiasbenedetto !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants