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 command docs #259

Merged
merged 4 commits into from
Jan 27, 2021
Merged

Update WP CLI command docs #259

merged 4 commits into from
Jan 27, 2021

Conversation

jeffpaul
Copy link
Member

Description of the Change

This PR attempts to update our WP CLI docs in README.md as well as the comments in our commands themselves.

Alternate Designs

n/a

Benefits

Ensures those looking to leverage ClassifAI WP CLI commands have easy access to documentation on how to leverage these commands.

Possible Drawbacks

none identified.

Verification Process

Run the commands locally with the various options to see ClassifAI processing posts, text, and attacments.

Checklist:

  • I have read the CONTRIBUTING document.
  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my change.
  • All new and existing tests passed.

Applicable Issues

n/a

Changelog Entry

Update docs (props @jeffpaul).

@jeffpaul jeffpaul added the needs:documentation This requires documentation. label Nov 13, 2020
@jeffpaul jeffpaul added this to the 1.7.0 milestone Nov 13, 2020
@jeffpaul jeffpaul self-assigned this Nov 13, 2020
@jeffpaul jeffpaul marked this pull request as ready for review November 13, 2020 15:41
Copy link
Contributor

@dinhtungdu dinhtungdu left a comment

Choose a reason for hiding this comment

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

The h6 with code style of GitHub (the gray color) makes the parameter hard to read for me. Replacing h6 with b looks better for me.

https://github.com/10up/classifai/tree/update/wp-cli-docs

@jeffpaul
Copy link
Member Author

@dinhtungdu sounds good, updated readme look good now?

@jeffpaul jeffpaul merged commit 5158431 into develop Jan 27, 2021
@jeffpaul jeffpaul deleted the update/wp-cli-docs branch January 27, 2021 22:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs:documentation This requires documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants