-
Notifications
You must be signed in to change notification settings - Fork 10
Improve top-level command descriptions; add Handbook links #7
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
Conversation
src/Capabilities_Command.php
Outdated
| * Manage user capabilities. | ||
| * Adds, removes, and lists capabilities of a user role. | ||
| * | ||
| * See references for [Roles and Capabilities](https://codex.wordpress.org/Roles_and_Capabilities)and [WP User class](https://codex.wordpress.org/Class_Reference/WP_User). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you add a space before and?
src/Role_Command.php
Outdated
| * Manage user roles. | ||
| * Manages user roles, including creating new roles and resetting to defaults. | ||
| * | ||
| * See references for [Roles and Capabilities](https://codex.wordpress.org/Roles_and_Capabilities)and [WP User class](https://codex.wordpress.org/Class_Reference/WP_User). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you add a space before and?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Will do, then I'll close this PR and submit a new one, correct. Before I do I'll wait to see what folk say about the line-break.
Long and multiple sentences in the descriptions are a problem b/c forced line breaks look OK in the code, for example, of this existing description:
https://github.com/hearvox/shell-command/edit/master/src/Shell_Command.php
But are grammatically wrong, bad for a11y, and look funny in the Handbook:
https://developer.wordpress.org/cli/commands/shell/
|
I feel uncomfortable at the position of the line break at description. @wp-cli/committers Any thoughts? |
|
@miya0001 We'll deal with the word-wrapping through the parsing code. |
Improve top-level command descriptions; add Handbook links


Related: /wp-cli/issues/4302
Changes:
Improve 'wp cap' command description in:
https://github.com/wp-cli/role-command/blob/master/src/Capabilities_Command.php
Command: wp cap
Current description: Manage user capabilities.
New description:
Adds, removes, and lists capabilities of a user role.
See references for Roles and Capabilitiesand WP User class.
Improve command description in:
https://github.com/wp-cli/role-command/blob/master/src/Role_Command.php
Command: wp role
Current description: Manage user roles.
New description:
Manages user roles, including creating new roles and resetting to defaults.
See references for Roles and Capabilitiesand WP User class.