feat: Add examples to --help output for "delete PROJECT ROLE-NAME" (a…

…rgoproj#15986) * feat: Add examples to --help output for delete PROJECT ROLE-NAME Signed-off-by: Shauryagulati <[email protected]> --------- Signed-off-by: Shauryagulati <[email protected]>
tesla59 · Dec 16, 2023 · a4f72b4 · a4f72b4
1 parent 7eb502c
commit a4f72b4
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/cmd/argocd/commands/project_role.go b/cmd/argocd/commands/project_role.go
@@ -18,6 +18,7 @@ import (
 	"github.com/argoproj/argo-cd/v2/util/errors"
 	"github.com/argoproj/argo-cd/v2/util/io"
 	"github.com/argoproj/argo-cd/v2/util/jwt"
+	"github.com/argoproj/argo-cd/v2/util/templates"
 )
 
 const (
@@ -176,6 +177,11 @@ func NewProjectRoleDeleteCommand(clientOpts *argocdclient.ClientOptions) *cobra.
 	var command = &cobra.Command{
 		Use:   "delete PROJECT ROLE-NAME",
 		Short: "Delete a project role",
+		Example: templates.Examples(`  
+  # Delete a project role from the "my-project" project with the name "my-role".
+  argocd proj role delete my-project my-role
+  		`),
+
 		Run: func(c *cobra.Command, args []string) {
 			ctx := c.Context()
 

diff --git a/docs/user-guide/commands/argocd_proj_role_delete.md b/docs/user-guide/commands/argocd_proj_role_delete.md
@@ -8,6 +8,13 @@ Delete a project role
 argocd proj role delete PROJECT ROLE-NAME [flags]
 ```
 
+### Examples
+
+```
+  # Delete a project role from the "my-project" project with the name "my-role".
+  argocd proj role delete my-project my-role
+```
+
 ### Options
 
 ```