humanmade / humanmade/Cavalcade

WP-CLI command documentation is not complete

Open
#77 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
PHP
Stars
542
Forks
48
PR merge metrics
No merged PRs in 30d

Description

The WP-CLI commands have sparse user-facing documentation, which does not give the user everything they need to know.

For example, the `@synopsis` tag tells me that the `jobs` command has a `status` filter, but not what the valid values for it are. I have to dig through the code to figure out that they're -- as far as I can tell -- `waiting`, `running`, `failed`, and `completed`.

[Adding option descriptions and examples](https://make.wordpress.org/cli/handbook/commands-cookbook/#annotating-with-phpdoc) would result in a much better UX.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.