Add defaults and accepted values for runcommand() options in doc by i-am-chitti · Pull Request #5953 · wp-cli/wp-cli
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is already somewhat documented in the same docblock right above this change and you can see it here: https://make.wordpress.org/cli/handbook/references/internal-api/wp-cli-runcommand/
Which documents all elements and some accepted values, but doesn't include defaults or full descriptions.
This new documentation looks to be missing command_args from the options array also. I added some suggestions for more detailed descriptions based on what the code actually does (which wasn't previously documented in full in the comments)