Skip to content

Conversation

@hearvox
Copy link
Contributor

@hearvox hearvox commented Sep 7, 2017

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.

* 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).
Copy link
Member

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?

* 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).
Copy link
Member

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?

Copy link
Contributor Author

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/

@miya0001
Copy link
Member

miya0001 commented Sep 7, 2017

wp role:

wp cap:

@miya0001
Copy link
Member

miya0001 commented Sep 7, 2017

I feel uncomfortable at the position of the line break at description.
But I can understand it is difficult to solve.

@wp-cli/committers Any thoughts?

@schlessera
Copy link
Member

Authoring props: @hearvox & @ako80218

@schlessera
Copy link
Member

@miya0001 We'll deal with the word-wrapping through the parsing code.

@schlessera schlessera merged commit 0e08cec into wp-cli:master Sep 8, 2017
schlessera added a commit that referenced this pull request Jan 5, 2022
Improve top-level command descriptions; add Handbook links
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants