Merge pull request #57 from ernilambar/fix-command-examples

swissspidy · web-flow · commit 788b1a967d9f · 2024-02-16T09:16:09.000+01:00
Correct super-admin commands examples
diff --git a/src/Super_Admin_Command.php b/src/Super_Admin_Command.php
@@ -7,18 +7,18 @@
  *
  * ## EXAMPLES
  *
- *     # List user with super-admin capabilities
+ *     # List user with super-admin capabilities.
  *     $ wp super-admin list
  *     supervisor
  *     administrator
  *
  *     # Grant super-admin privileges to the user.
  *     $ wp super-admin add superadmin2
- *     Success: Granted super-admin capabilities.
+ *     Success: Granted super-admin capabilities to 1 user.
  *
- *     # Revoke super-admin privileges to the user.
+ *     # Revoke super-admin privileges from the user.
  *     $ wp super-admin remove superadmin2
- *     Success: Revoked super-admin capabilities.
+ *     Success: Revoked super-admin capabilities from 1 user.
  *
  * @package wp-cli
  */
@@ -54,7 +54,7 @@ public function __construct() {
 	 *
 	 * ## EXAMPLES
 	 *
-	 *     # List user with super-admin capabilities
+	 *     # List user with super-admin capabilities.
 	 *     $ wp super-admin list
 	 *     supervisor
 	 *     administrator
@@ -92,8 +92,9 @@ public function list_subcommand( $_, $assoc_args ) {
 	 *
 	 * ## EXAMPLES
 	 *
+	 *     # Grant super-admin privileges to the user.
 	 *     $ wp super-admin add superadmin2
-	 *     Success: Granted super-admin capabilities.
+	 *     Success: Granted super-admin capabilities to 1 user.
 	 */
 	public function add( $args, $_ ) {
 
@@ -156,8 +157,9 @@ public function add( $args, $_ ) {
 	 *
 	 * ## EXAMPLES
 	 *
+	 *     # Revoke super-admin privileges from the user.
 	 *     $ wp super-admin remove superadmin2
-	 *     Success: Revoked super-admin capabilities.
+	 *     Success: Revoked super-admin capabilities from 1 user.
 	 */
 	public function remove( $args, $_ ) {
 		$users             = $this->fetcher->get_many( $args );

Original file line number	Diff line number	Diff line change
`@@ -7,18 +7,18 @@`
`7`	`7`	`*`
`8`	`8`	`* ## EXAMPLES`
`9`	`9`	`*`
`10`		`- * # List user with super-admin capabilities`
	`10`	`+ * # List user with super-admin capabilities.`
`11`	`11`	`* $ wp super-admin list`
`12`	`12`	`* supervisor`
`13`	`13`	`* administrator`
`14`	`14`	`*`
`15`	`15`	`* # Grant super-admin privileges to the user.`
`16`	`16`	`* $ wp super-admin add superadmin2`
`17`		`- * Success: Granted super-admin capabilities.`
	`17`	`+ * Success: Granted super-admin capabilities to 1 user.`
`18`	`18`	`*`
`19`		`- * # Revoke super-admin privileges to the user.`
	`19`	`+ * # Revoke super-admin privileges from the user.`
`20`	`20`	`* $ wp super-admin remove superadmin2`
`21`		`- * Success: Revoked super-admin capabilities.`
	`21`	`+ * Success: Revoked super-admin capabilities from 1 user.`
`22`	`22`	`*`
`23`	`23`	`* @package wp-cli`
`24`	`24`	`*/`
`@@ -54,7 +54,7 @@ public function __construct() {`
`54`	`54`	`*`
`55`	`55`	`* ## EXAMPLES`
`56`	`56`	`*`
`57`		`- * # List user with super-admin capabilities`
	`57`	`+ * # List user with super-admin capabilities.`
`58`	`58`	`* $ wp super-admin list`
`59`	`59`	`* supervisor`
`60`	`60`	`* administrator`
`@@ -92,8 +92,9 @@ public function list_subcommand( $_, $assoc_args ) {`
`92`	`92`	`*`
`93`	`93`	`* ## EXAMPLES`
`94`	`94`	`*`
	`95`	`+ * # Grant super-admin privileges to the user.`
`95`	`96`	`* $ wp super-admin add superadmin2`
`96`		`- * Success: Granted super-admin capabilities.`
	`97`	`+ * Success: Granted super-admin capabilities to 1 user.`
`97`	`98`	`*/`
`98`	`99`	`public function add( $args, $_ ) {`
`99`	`100`
`@@ -156,8 +157,9 @@ public function add( $args, $_ ) {`
`156`	`157`	`*`
`157`	`158`	`* ## EXAMPLES`
`158`	`159`	`*`
	`160`	`+ * # Revoke super-admin privileges from the user.`
`159`	`161`	`* $ wp super-admin remove superadmin2`
`160`		`- * Success: Revoked super-admin capabilities.`
	`162`	`+ * Success: Revoked super-admin capabilities from 1 user.`
`161`	`163`	`*/`
`162`	`164`	`public function remove( $args, $_ ) {`
`163`	`165`	`$users = $this->fetcher->get_many( $args );`