Skip to content

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

Merged
danielbachhuber merged 3 commits into
wp-cli:mainfrom
benlk:148-docs-improvements-db-check
Nov 6, 2023
Merged

Document what wp db check doesn't do; provide suggestions for next commands#244
danielbachhuber merged 3 commits into
wp-cli:mainfrom
benlk:148-docs-improvements-db-check

Conversation

@benlk

@benlk benlk commented Oct 26, 2023

Copy link
Copy Markdown
Contributor

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
Comment thread src/DB_Command.php Outdated
Comment thread src/DB_Command.php Outdated
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
Copy Markdown
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
Copy Markdown
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 command:db Related to 'db' command command:db-check Related to 'db check' command labels Nov 6, 2023
@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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

command:db Related to 'db' command command:db-check Related to 'db check' command

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants