commands/user: improve user verify documentation (mattermost#502)

dsharma522 · Apr 6, 2022 · 8c9cb86 · 8c9cb86
1 parent ce04482
commit 8c9cb86
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 5 deletions.
diff --git a/commands/user.go b/commands/user.go
@@ -169,8 +169,8 @@ var ListUsersCmd = &cobra.Command{
 
 var VerifyUserEmailWithoutTokenCmd = &cobra.Command{
 	Use:     "verify [users]",
-	Short:   "Verify email of users",
-	Long:    "Verify the user's email address.",
+	Short:   "Mark user's email as verified",
+	Long:    "Mark user's email as verified without requiring user to complete email verification path.",
 	Example: "  user verify user1",
 	RunE:    withClient(verifyUserEmailWithoutTokenCmdF),
 	Args:    cobra.MinimumNArgs(1),

diff --git a/docs/mmctl_user.rst b/docs/mmctl_user.rst
@@ -54,5 +54,5 @@ SEE ALSO
 * `mmctl user resetmfa <mmctl_user_resetmfa.rst>`_ 	 - Turn off MFA
 * `mmctl user search <mmctl_user_search.rst>`_ 	 - Search for users
 * `mmctl user username <mmctl_user_username.rst>`_ 	 - Change username of the user
-* `mmctl user verify <mmctl_user_verify.rst>`_ 	 - Verify email of users
+* `mmctl user verify <mmctl_user_verify.rst>`_ 	 - Mark user's email as verified
 
diff --git a/docs/mmctl_user_verify.rst b/docs/mmctl_user_verify.rst
@@ -3,13 +3,13 @@
 mmctl user verify
 -----------------
 
-Verify email of users
+Mark user's email as verified
 
 Synopsis
 ~~~~~~~~
 
 
-Verify the user's email address.
+Mark user's email as verified without requiring user to complete email verification path.
 
 ::