Skip to content
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

Document what wp db check doesn't do; provide suggestions for next commands #244

Merged
merged 3 commits into from Nov 6, 2023

Conversation

benlk
Copy link
Contributor

@benlk benlk commented Oct 26, 2023

Changes

  • adds documentation to note that wp db check doesn't check anything WordPress-specific
  • adds suggested follow-up commands for checking WordPress-specific parts of the DB

Why

#148

@benlk benlk requested a review from a team as a code owner October 26, 2023 15:56
src/DB_Command.php Outdated Show resolved Hide resolved
@@ -258,6 +261,8 @@ public function check( $_, $assoc_args ) {

WP_CLI::debug( 'Associative arguments: ' . json_encode( $assoc_args ), 'db' );
WP_CLI::success( 'Database checked.' );
WP_CLI::log( 'To check whether the WordPress DB tables are installed: wp core is-installed', 'db' );
WP_CLI::log( 'To check whether the WordPress DB tables need to be updated: wp core update-db --dry-run', 'db' );
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We generally don't render any output after WP_CLI::success().

For this particular problem, I'd prefer to remove these WP_CLI::log() statements and simply keep to the command doc changes.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed in 1debf78

@danielbachhuber danielbachhuber added this to the 2.0.27 milestone Nov 6, 2023
@danielbachhuber danielbachhuber merged commit 6d207f7 into wp-cli:main Nov 6, 2023
26 of 36 checks passed
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.

None yet

3 participants