Improve top-level command descriptions; add Handbook links#7
Improve top-level command descriptions; add Handbook links#7schlessera merged 4 commits intowp-cli:masterfrom
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.
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.
Can you add a space before and?
There was a problem hiding this comment.
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.