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.
The WP-CLI commands have sparse user-facing documentation, which does not give the user everything they need to know.
For example, the
@synopsistag tells me that thejobscommand has astatusfilter, 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, andcompleted.Adding option descriptions and examples would result in a much better UX.