Update doc for user spam and unspam command (#483)

wp-cli · Mar 1, 2024 · 0c41ec2 · 0c41ec2
1 parent cdaca28
commit 0c41ec2
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -6248,7 +6248,7 @@ wp user set-role <user> [<role>]
 
 ### wp user spam
 
-Marks one or more users as spam.
+Marks one or more users as spam on multisite.
 
 ~~~
 wp user spam <id>...
@@ -6261,6 +6261,7 @@ wp user spam <id>...
 
 **EXAMPLES**
 
+    # Mark user as spam.
     $ wp user spam 123
     User 123 marked as spam.
     Success: Spammed 1 of 1 users.
@@ -6432,7 +6433,7 @@ Replaces existing terms on the object.
 
 ### wp user unspam
 
-Removes one or more users from spam.
+Removes one or more users from spam on multisite.
 
 ~~~
 wp user unspam <id>...
@@ -6445,6 +6446,7 @@ wp user unspam <id>...
 
 **EXAMPLES**
 
+    # Remove user from spam.
     $ wp user unspam 123
     User 123 removed from spam.
     Success: Unspamed 1 of 1 users.

diff --git a/src/User_Command.php b/src/User_Command.php
@@ -1282,7 +1282,7 @@ public static function wp_new_user_notification( $user_id, $password ) {
 	}
 
 	/**
-	 * Marks one or more users as spam.
+	 * Marks one or more users as spam on multisite.
 	 *
 	 * ## OPTIONS
 	 *
@@ -1291,6 +1291,7 @@ public static function wp_new_user_notification( $user_id, $password ) {
 	 *
 	 * ## EXAMPLES
 	 *
+	 *     # Mark user as spam.
 	 *     $ wp user spam 123
 	 *     User 123 marked as spam.
 	 *     Success: Spammed 1 of 1 users.
@@ -1300,7 +1301,7 @@ public function spam( $args ) {
 	}
 
 	/**
-	 * Removes one or more users from spam.
+	 * Removes one or more users from spam on multisite.
 	 *
 	 * ## OPTIONS
 	 *
@@ -1309,6 +1310,7 @@ public function spam( $args ) {
 	 *
 	 * ## EXAMPLES
 	 *
+	 *     # Remove user from spam.
 	 *     $ wp user unspam 123
 	 *     User 123 removed from spam.
 	 *     Success: Unspamed 1 of 1 users.