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

Update WP-CLI documentation #2369

Merged
merged 1 commit into from
Sep 27, 2021
Merged

Update WP-CLI documentation #2369

merged 1 commit into from
Sep 27, 2021

Conversation

felipeelia
Copy link
Member

Description of the Change

This PR updates our WP-CLI commands documentation. It was generated with this WP-CLI command using:

wp cli-command-docs elasticpress --custom-order=index,activate-feature,deactivate-feature,list-features,get-algorithm-version,set-algorithm-version --remove=delete_transient_on_int,custom_get_transient --custom-intro='The following WP-CLI commands are supported by ElasticPress:' > docs/wp-cli.md

Another PR will follow this one to make this process automatic.

Benefits

WP-CLI already relies on the DocBlock above each subcommand. Generating the documentation from it we will have both things always sync'd.

Possible Drawbacks

None. If someone wants to contribute with WP-CLI documentation specifically, it should be only a matter of updating the docblock in Command.php.

Changelog Entry

Changed: WP-CLI documentation was updated

Copy link
Member

@jeffpaul jeffpaul left a comment

Choose a reason for hiding this comment

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

looks good to me!

@felipeelia felipeelia merged commit 9b7388f into develop Sep 27, 2021
@felipeelia felipeelia deleted the docs/update-wp-cli.md branch September 27, 2021 13:52
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