Merge pull request #114 from DrewAPicture/issue/doc-verbs

Convert entity command help summaries to use third-person singular verbs.

Author: danielbachhuber

README.md

@@ -44,7 +44,7 @@ public function __construct() {
 	}
 
 	/**
-	 * Create a new comment.
+	 * Creates a new comment.
 	 *
 	 * ## OPTIONS
 	 *
@@ -87,7 +87,7 @@ public function create( $args, $assoc_args ) {
 	}
 
 	/**
-	 * Update one or more comments.
+	 * Updates one or more comments.
 	 *
 	 * ## OPTIONS
 	 *
@@ -115,7 +115,7 @@ public function update( $args, $assoc_args ) {
 	}
 
 	/**
-	 * Generate some number of new dummy comments.
+	 * Generates some number of new dummy comments.
 	 *
 	 * Creates a specified number of new comments with dummy data.
 	 *
@@ -194,7 +194,7 @@ public function generate( $args, $assoc_args ) {
 	}
 
 	/**
-	 * Get data of a single comment.
+	 * Gets the data of a single comment.
 	 *
 	 * ## OPTIONS
 	 *
@@ -241,7 +241,7 @@ public function get( $args, $assoc_args ) {
 	}
 
 	/**
-	 * Get a list of comments.
+	 * Gets a list of comments.
 	 *
 	 * ## OPTIONS
 	 *
@@ -366,7 +366,7 @@ public function list_( $_, $assoc_args ) {
 	}
 
 	/**
-	 * Delete a comment.
+	 * Deletes a comment.
 	 *
 	 * ## OPTIONS
 	 *
@@ -431,7 +431,7 @@ private function set_status( $args, $status, $success ) {
 	}
 
 	/**
-	 * Warn if `$_SERVER['SERVER_NAME']` not set as used in email from-address sent to post author in `wp_notify_postauthor()`.
+	 * Warns if `$_SERVER['SERVER_NAME']` not set as used in email from-address sent to post author in `wp_notify_postauthor()`.
 	 */
 	private function check_server_name() {
 		if ( empty( $_SERVER['SERVER_NAME'] ) ) {
@@ -441,7 +441,7 @@ private function check_server_name() {
 	}
 
 	/**
-	 * Trash a comment.
+	 * Trashes a comment.
 	 *
 	 * ## OPTIONS
 	 *
@@ -461,7 +461,7 @@ public function trash( $args, $assoc_args ) {
 	}
 
 	/**
-	 * Untrash a comment.
+	 * Untrashes a comment.
 	 *
 	 * ## OPTIONS
 	 *
@@ -482,7 +482,7 @@ public function untrash( $args, $assoc_args ) {
 	}
 
 	/**
-	 * Mark a comment as spam.
+	 * Marks a comment as spam.
 	 *
 	 * ## OPTIONS
 	 *
@@ -502,7 +502,7 @@ public function spam( $args, $assoc_args ) {
 	}
 
 	/**
-	 * Unmark a comment as spam.
+	 * Unmarks a comment as spam.
 	 *
 	 * ## OPTIONS
 	 *
@@ -523,7 +523,7 @@ public function unspam( $args, $assoc_args ) {
 	}
 
 	/**
-	 * Approve a comment.
+	 * Approves a comment.
 	 *
 	 * ## OPTIONS
 	 *
@@ -544,7 +544,7 @@ public function approve( $args, $assoc_args ) {
 	}
 
 	/**
-	 * Unapprove a comment.
+	 * Unapproves a comment.
 	 *
 	 * ## OPTIONS
 	 *
@@ -565,7 +565,7 @@ public function unapprove( $args, $assoc_args ) {
 	}
 
 	/**
-	 * Count comments, on whole blog or on a given post.
+	 * Counts comments, on whole blog or on a given post.
 	 *
 	 * ## OPTIONS
 	 *
@@ -610,7 +610,7 @@ public function count( $args, $assoc_args ) {
 	}
 
 	/**
-	 * Recalculate the comment_count value for one or more posts.
+	 * Recalculates the comment_count value for one or more posts.
 	 *
 	 * ## OPTIONS
 	 *
@@ -636,7 +636,7 @@ public function recount( $args ) {
 	}
 
 	/**
-	 * Get status of a comment.
+	 * Gets the status of a comment.
 	 *
 	 * ## OPTIONS
 	 *
@@ -662,7 +662,7 @@ public function status( $args, $assoc_args ) {
 	}
 
 	/**
-	 * Verify whether a comment exists.
+	 * Verifies whether a comment exists.
 	 *
 	 * Displays a success message if the comment does exist.
 	 *

src/Comment_Command.php

@@ -1,7 +1,7 @@
 <?php
 
 /**
- * Manage comment custom fields.
+ * Adds, updates, deletes, and lists comment custom fields.
  *
  * ## EXAMPLES
  *

src/Comment_Meta_Command.php

@@ -44,7 +44,7 @@ class Menu_Command extends WP_CLI_Command {
 	);
 
 	/**
-	 * Create a new menu.
+	 * Creates a new menu.
 	 *
 	 * ## OPTIONS
 	 *
@@ -79,7 +79,7 @@ public function create( $args, $assoc_args ) {
 	}
 
 	/**
-	 * Delete one or more menus.
+	 * Deletes one or more menus.
 	 *
 	 * ## OPTIONS
 	 *
@@ -109,7 +109,7 @@ public function delete( $args, $_ ) {
 	}
 
 	/**
-	 * Get a list of menus.
+	 * Gets a list of menus.
 	 *
 	 * ## OPTIONS
 	 *

src/Menu_Command.php

@@ -30,7 +30,7 @@ class Menu_Item_Command extends WP_CLI_Command {
 	);
 
 	/**
-	 * Get a list of items associated with a menu.
+	 * Gets a list of items associated with a menu.
 	 *
 	 * ## OPTIONS
 	 *
@@ -115,7 +115,7 @@ public function list_( $args, $assoc_args ) {
 	}
 
 	/**
-	 * Add a post as a menu item.
+	 * Adds a post as a menu item.
 	 *
 	 * ## OPTIONS
 	 *
@@ -173,7 +173,7 @@ public function add_post( $args, $assoc_args ) {
 	}
 
 	/**
-	 * Add a taxonomy term as a menu item.
+	 * Adds a taxonomy term as a menu item.
 	 *
 	 * ## OPTIONS
 	 *
@@ -235,7 +235,7 @@ public function add_term( $args, $assoc_args ) {
 	}
 
 	/**
-	 * Add a custom menu item.
+	 * Adds a custom menu item.
 	 *
 	 * ## OPTIONS
 	 *
@@ -286,7 +286,7 @@ public function add_custom( $args, $assoc_args ) {
 	}
 
 	/**
-	 * Update a menu item.
+	 * Updates a menu item.
 	 *
 	 * ## OPTIONS
 	 *
@@ -340,7 +340,7 @@ public function update( $args, $assoc_args ) {
 	}
 
 	/**
-	 * Delete one or more items from a menu.
+	 * Deletes one or more items from a menu.
 	 *
 	 * ## OPTIONS
 	 *

src/Menu_Item_Command.php

@@ -1,7 +1,7 @@
 <?php
 
 /**
- * Manage a menu's assignment to locations.
+ * Assigns, removes, and lists a menu's locations.
  *
  * ## EXAMPLES
  *
@@ -25,7 +25,7 @@
 class Menu_Location_Command extends WP_CLI_Command {
 
 	/**
-	 * List locations for the current theme.
+	 * Lists locations for the current theme.
 	 *
 	 * ## OPTIONS
 	 *
@@ -87,7 +87,7 @@ function($o) {
 	}
 
 	/**
-	 * Assign a location to a menu.
+	 * Assigns a location to a menu.
 	 *
 	 * ## OPTIONS
 	 *
@@ -127,7 +127,7 @@ public function assign( $args, $_ ) {
 	}
 
 	/**
-	 * Remove a location from a menu.
+	 * Removes a location from a menu.
 	 *
 	 * ## OPTIONS
 	 *

src/Menu_Location_Command.php

@@ -1,7 +1,7 @@
 <?php
 
 /**
- * Manage network custom fields.
+ * Gets, adds, updates, deletes, and lists network custom fields.
  *
  * ## EXAMPLES
  *

src/Network_Meta_Command.php

@@ -31,7 +31,7 @@
 class Option_Command extends WP_CLI_Command {
 
 	/**
-	 * Get the value for an option.
+	 * Gets the value for an option.
 	 *
 	 * ## OPTIONS
 	 *
@@ -83,7 +83,7 @@ public function get( $args, $assoc_args ) {
 	}
 
 	/**
-	 * Add a new option value.
+	 * Adds a new option value.
 	 *
 	 * Errors if the option already exists.
 	 *
@@ -138,7 +138,7 @@ public function add( $args, $assoc_args ) {
 	}
 
 	/**
-	 * List options and their values.
+	 * Lists options and their values.
 	 *
 	 * ## OPTIONS
 	 *
@@ -326,7 +326,7 @@ public function list_( $args, $assoc_args ) {
 	}
 
 	/**
-	 * Update an option value.
+	 * Updates an option value.
 	 *
 	 * ## OPTIONS
 	 *
@@ -416,7 +416,7 @@ public function update( $args, $assoc_args ) {
 	}
 
 	/**
-	 * Delete an option.
+	 * Deletes an option.
 	 *
 	 * ## OPTIONS
 	 *
@@ -440,7 +440,7 @@ public function delete( $args ) {
 	}
 
 	/**
-	 * Get a nested value from an option.
+	 * Gets a nested value from an option.
 	 *
 	 * ## OPTIONS
 	 *
@@ -488,7 +488,7 @@ public function pluck( $args, $assoc_args ) {
 	}
 
 	/**
-	 * Update a nested value in an option.
+	 * Updates a nested value in an option.
 	 *
 	 * ## OPTIONS
 	 *