- Notifications
You must be signed in to change notification settings - Fork 353
Description
1) A meta question
I wanted to submit a change to the output of purely wp itself (aka "help index" aka "manpage index"). Which file(s) are used to build this? The content which starts like:
NAME wp DESCRIPTION Manage WordPress through the command-line. SYNOPSIS wp <command> SUBCOMMANDS ... Did a full text search for Manage WordPress through the command-line in both https://github.com/wp-cli/handbook and https://github.com/wp-cli/wp-cli but found nothing. I had wanted to submit a change to this as a pull request. But as I was not able to find the source for this, I put my proposal here itself.
2) The change proposal itself
In the section "SUBCOMMANDS" the help command itself is summarized like this:
help Gets help on WP-CLI, or on a specific command. And only at the very end you have:
Run 'wp help <command>' to get more information on a specific command. This is not so ideal. I propose to do one of the following:
a) Amend the SYNOPSIS section.
SYNOPSIS wp <command> wp help <specific-command> b) Or in the SUBCOMMANDS section change the help command:
help Gets general help on WP-CLI. What you are currently reading. help <cmd> Gets help on a specific <cmd> in WP-CLI. I even would propose to except those from the alphabetical order and put them first, with one empty line inbetween, as they are serve as a quick lookup from more specific help.