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

ernilambar · web-flow · commit 0c41ec28aa4b · 2024-03-01T04:11:23.000-08:00
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.

Original file line number	Diff line number	Diff line change
`@@ -1282,7 +1282,7 @@ public static function wp_new_user_notification( $user_id, $password ) {`
`1282`	`1282`	`}`
`1283`	`1283`
`1284`	`1284`	`/**`
`1285`		`- * Marks one or more users as spam.`
	`1285`	`+ * Marks one or more users as spam on multisite.`
`1286`	`1286`	`*`
`1287`	`1287`	`* ## OPTIONS`
`1288`	`1288`	`*`
`@@ -1291,6 +1291,7 @@ public static function wp_new_user_notification( $user_id, $password ) {`
`1291`	`1291`	`*`
`1292`	`1292`	`* ## EXAMPLES`
`1293`	`1293`	`*`
	`1294`	`+ * # Mark user as spam.`
`1294`	`1295`	`* $ wp user spam 123`
`1295`	`1296`	`* User 123 marked as spam.`
`1296`	`1297`	`* Success: Spammed 1 of 1 users.`
`@@ -1300,7 +1301,7 @@ public function spam( $args ) {`
`1300`	`1301`	`}`
`1301`	`1302`
`1302`	`1303`	`/**`
`1303`		`- * Removes one or more users from spam.`
	`1304`	`+ * Removes one or more users from spam on multisite.`
`1304`	`1305`	`*`
`1305`	`1306`	`* ## OPTIONS`
`1306`	`1307`	`*`
`@@ -1309,6 +1310,7 @@ public function spam( $args ) {`
`1309`	`1310`	`*`
`1310`	`1311`	`* ## EXAMPLES`
`1311`	`1312`	`*`
	`1313`	`+ * # Remove user from spam.`
`1312`	`1314`	`* $ wp user unspam 123`
`1313`	`1315`	`* User 123 removed from spam.`
`1314`	`1316`	`* Success: Unspamed 1 of 1 users.`