Skip to content

Commit aca81e1

Browse files
authored
Merge pull request #469 from imjoey/improve_cmd_desc
Improve the commands descriptions
2 parents 388230d + 6588609 commit aca81e1

File tree

5 files changed

+9
-9
lines changed

5 files changed

+9
-9
lines changed

cmd/alpha.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ import (
2525
func newAlphaCommand() *cobra.Command {
2626
cmd := &cobra.Command{
2727
Use: "alpha",
28-
Short: "Exposes commands which are in experimental or early stages of development",
28+
Short: "Expose commands which are in experimental or early stages of development",
2929
Long: `Command group for commands which are either experimental or in early stages of development`,
3030
Example: `
3131
# scaffolds webhook server

cmd/docs.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ import (
2424
func newDocsCmd() *cobra.Command {
2525
return &cobra.Command{
2626
Use: "docs",
27-
Short: "Generate API reference docs. Coming soon.",
28-
Long: `updates vendor dependencies. Coming soon.`,
27+
Short: "Generate API reference docs. Coming soon",
28+
Long: `Update vendor dependencies. Coming soon`,
2929
Run: func(cmd *cobra.Command, args []string) {
3030
fmt.Println("Coming soon.")
3131
},

cmd/main.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -83,8 +83,8 @@ Typical project lifecycle:
8383
8484
kubebuilder create api --group <group> --version <version> --kind <Kind>
8585
86-
create resource will prompt the user for if it should scaffold the Resource and / or Controller. To only
87-
scaffold a Controller for an existing Resource, select "n" for Resource. To only define
86+
Create resource will prompt the user for if it should scaffold the Resource and / or Controller. To only
87+
scaffold a Controller for an existing Resource, select "n" for Resource. To only define
8888
the schema for a Resource without writing a Controller, select "n" for Controller.
8989
9090
After the scaffold is written, api will run make on the project.

cmd/vendor_update.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ import (
2828
func newVendorUpdateCmd() *cobra.Command {
2929
return &cobra.Command{
3030
Use: "update",
31-
Short: "updates vendor dependencies.",
32-
Long: `updates vendor dependencies.`,
31+
Short: "Update vendor dependencies",
32+
Long: `Update vendor dependencies`,
3333
Example: `Update the vendor dependencies:
3434
kubebuilder update vendor
3535
`,

cmd/version/version.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,8 @@ func (v Version) Print() {
5959
func NewVersionCmd() *cobra.Command {
6060
return &cobra.Command{
6161
Use: "version",
62-
Short: "Print the kubebuilder version.",
63-
Long: `Print the kubebuilder version.`,
62+
Short: "Print the kubebuilder version",
63+
Long: `Print the kubebuilder version`,
6464
Example: `kubebuilder version`,
6565
Run: runVersion,
6666
}

0 commit comments

Comments
 (0)