Improve top-level commands; add reference links #83
Conversation
src/User_Command.php
Outdated
| * Manage users. | ||
| * Manages users, along with their roles, capabilities, and meta. | ||
| * | ||
| * 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.
Missing a space after the first link.
src/Term_Command.php
Outdated
| @@ -3,7 +3,9 @@ | |||
| use WP_CLI\Utils; | |||
|
|
|||
| /** | |||
| * Manage terms. | |||
| * Manages taxonomy terms and term meta, including create, delete, and list. | |||
There was a problem hiding this comment.
including would need to be followed by nouns.
Here's two options:
Manages taxonomy terms and term meta, including creation, deletion, and enumerationManages taxonomy terms and term meta and allows to create, delete, and list them.
There was a problem hiding this comment.
Tryig to keep it under 80chars, how about:
Manages taxonomy terms and term meta, with create, delete, and list commands.
src/Post_Type_Command.php
Outdated
| @@ -2,6 +2,8 @@ | |||
| /** | |||
| * Retrieves details on the site's registered post-types. | |||
| * | |||
| * Get details on WordPress built-in and [custom post types](https://developer.wordpress.org/plugins/post-types/). | |||
src/Post_Type_Command.php
Outdated
| * Retrieves details on the site's registered post-types. | ||
| * Retrieves details on the site's registered post types. | ||
| * | ||
| * Get information on the WordPress' built-in and the site's [custom post types](https://developer.wordpress.org/plugins/post-types/). |
There was a problem hiding this comment.
The first the (in front of WordPress') seems grammatically wrong to me.
There was a problem hiding this comment.
Sorry, that was a mistake. Correcting now.
Also, I don't know what this means:
please re-run wp scaffold package-readme to update the README.md file again.
Is that something I need to do on my end? If so, please send details.
There was a problem hiding this comment.
The README.md files inside of the command packages are automatically generated through the wp scaffold package-readme command: https://github.com/wp-cli/scaffold-package-command#wp-scaffold-package-readme
So, any time you change the documentation part of the source files, you'll need to re-run wp scaffold package-readme . --force from inside the root folder of that package to update the README.md file to the latest changes.
You might need to install the command first, if you haven't done so: wp package install wp-cli/scaffold-package-command
There was a problem hiding this comment.
Ah, I see: But I'm editing files in my forked repo directly on GitHub, not in a local version on my computer. So I'm guessing there is no way to run that package here on GitHub. Is there another way to update the README without me having to download the repo?
There was a problem hiding this comment.
We'll run the script over all packages once we've merged the updated descriptions.
There was a problem hiding this comment.
Thanks, @schlessera , that will save me some time (tho cost you some). Appreciated. We got diverted but have a few more PRs to submit for command descriptions. Will try to get to that today. And thanks to @miya0001 for all his help too.
cc @ako80218
Related: /wp-cli/issues/4302
Also updated README.md with the following new command descriptions.
Changes:
Improve 'wp comment' command description in:
https://github.com/wp-cli/entity-command/blob/master/src/Comment_Command.php
(Related: (wp-cli/wp-cli#4302)[https://github.com/wp-cli/wp-cli/issues/4302]))
Current description: Manage comments.
New description:
Creates, updates, deletes, and moderates comments.
https://github.com/wp-cli/entity-command/issues
Improve 'wp menu' command description in:
https://github.com/wp-cli/entity-command/blob/master/src/Menu_Command.php
New second sentence:
See the Navigation Menus reference in the Theme Handbook.
Improve 'wp option' command description in:
https://github.com/wp-cli/entity-command/blob/master/src/Option_Command.php
Current description: Manage options.
New description:
Retrieves and sets site options, including plugin and WordPress settings.
See the Plugin Settings API and the
Theme Options for more information on adding customized options.
Improve 'wp post-type' command description in:
https://github.com/wp-cli/entity-command/blob/master/src/Post_Type_Command.php
Current description: Manage post types.
New second sentence:
Get details on WordPress built-in and custom post types.
Improve 'wp site' command description in:
https://github.com/wp-cli/entity-command/blob/master/src/Site_Command.php
Current description: Perform site-wide operations.
New description:
Performs site-wide operations on a multisite install.
Improve 'wp taxonomy' command description in:
https://github.com/wp-cli/entity-command/blob/master/src/Taxonomy_Command.php
Current description: Manage taxonomies.
New description:
Retrieves information about registered taxonomies.
See references for built-in taxonomies and custom taxonomies.
Improve 'wp term' command description in:
https://github.com/wp-cli/entity-command/blob/master/src/Term_Command.php
Current description: Manage terms.
New description:
Manages taxonomy terms and term meta, including create, delete, and list.
See reference for taxonomies and their terms.
Improve 'wp user' command description in:
https://github.com/wp-cli/entity-command/blob/master/src/User_Command.php
Current description: Manage users.
New description:
Manages users, along with their roles, capabilities, and meta.
See references for Roles and Capabilitiesand WP User class.