Merge pull request #39 from zalmarge/master

Fix documentation for BGP flag in `project create`.
cherryservers · Apr 25, 2024 · 13ca4c7 · 13ca4c7
2 parents 1cecb60 + 15104f1
commit 13ca4c7
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 6 deletions.
diff --git a/docs/cherryctl_project_create.md b/docs/cherryctl_project_create.md
@@ -13,14 +13,14 @@ cherryctl project create -t <team_id> --name <project_name> [--bgp <bool>] [flag
 ### Examples
 
 ```
-  # To create a new project with BGP enabled:
-  cherryctl project create -t 12345 --name "Project with BGP" --bgp true
+  # To create a new project with BGP support enabled:
+  cherryctl project create -t 12345 --name "Project with BGP" --bgp
 ```
 
 ### Options
 
 ```
-  -b, --bgp           True to enable BGP in a project.
+  -b, --bgp           Enable BGP support.
   -h, --help          help for create
       --name string   Project name.
   -t, --team-id int   The teams's ID.

diff --git a/internal/projects/create.go b/internal/projects/create.go
@@ -19,8 +19,8 @@ func (c *Client) Create() *cobra.Command {
 		Use:   `create -t <team_id> --name <project_name> [--bgp <bool>]`,
 		Short: "Create a project.",
 		Long:  "Create a new project in a speficied team.",
-		Example: `  # To create a new project with BGP enabled:
-  cherryctl project create -t 12345 --name "Project with BGP" --bgp true`,
+		Example: `  # To create a new project with BGP support enabled:
+  cherryctl project create -t 12345 --name "Project with BGP" --bgp`,
 
 		RunE: func(cmd *cobra.Command, args []string) error {
 			cmd.SilenceUsage = true
@@ -43,7 +43,7 @@ func (c *Client) Create() *cobra.Command {
 	}
 
 	projectCreateCmd.Flags().IntVarP(&teamID, "team-id", "t", 0, "The teams's ID.")
-	projectCreateCmd.Flags().BoolVarP(&bgp, "bgp", "b", false, "True to enable BGP in a project.")
+	projectCreateCmd.Flags().BoolVarP(&bgp, "bgp", "b", false, "Enable BGP support.")
 	projectCreateCmd.Flags().StringVarP(&name, "name", "", "", "Project name.")
 
 	projectCreateCmd.MarkFlagRequired("team-id")