Added command explanations

craftamap · Oct 29, 2020 · 12c0a68 · 12c0a68
1 parent 654dc6e
commit 12c0a68
Show file tree

Hide file tree

Showing 6 changed files with 18 additions and 6 deletions.
diff --git a/cmd/commands/pr/create/create.go b/cmd/commands/pr/create/create.go
@@ -21,7 +21,8 @@ var (
 
 func Add(prCmd *cobra.Command, globalOpts *options.GlobalOptions) {
 	createCmd := &cobra.Command{
-		Use: "create",
+		Use:   "create",
+		Short: "Create a pull request",
 		Run: func(cmd *cobra.Command, args []string) {
 			var (
 				sourceBranch string

diff --git a/cmd/commands/pr/list/list.go b/cmd/commands/pr/list/list.go
@@ -12,7 +12,9 @@ import (
 
 func Add(prCmd *cobra.Command, globalOpts *options.GlobalOptions) {
 	listCmd := &cobra.Command{
-		Use: "list",
+		Use:   "list",
+		Short: "List and filter pull requests in this repository",
+		Long:  "List and filter pull requests in this repository",
 		Run: func(cmd *cobra.Command, args []string) {
 			c := internal.Client{
 				Username: globalOpts.Username,

diff --git a/cmd/commands/pr/pr.go b/cmd/commands/pr/pr.go
@@ -12,7 +12,9 @@ import (
 
 func Add(rootCmd *cobra.Command, globalOpts *options.GlobalOptions) {
 	prCommand := cobra.Command{
-		Use: "pr",
+		Use:   "pr",
+		Long:  "Work with pull requests",
+		Short: "Manage pull requests",
 	}
 
 	list.Add(&prCommand, globalOpts)

diff --git a/cmd/commands/pr/statuses/statuses.go b/cmd/commands/pr/statuses/statuses.go
@@ -14,7 +14,9 @@ import (
 
 func Add(prCmd *cobra.Command, globalOpts *options.GlobalOptions) {
 	statusesCmd := &cobra.Command{
-		Use: "statuses",
+		Use:   "statuses",
+		Short: "Show CI status for a single pull request",
+		Long:  "Show CI status for a single pull request",
 		Run: func(cmd *cobra.Command, args []string) {
 			var id int
 			var err error

diff --git a/cmd/commands/pr/view/view.go b/cmd/commands/pr/view/view.go
@@ -15,7 +15,9 @@ import (
 
 func Add(prCmd *cobra.Command, globalOpts *options.GlobalOptions) {
 	viewCmd := &cobra.Command{
-		Use: "view",
+		Use:   "view",
+		Short: "View a pull request",
+		Long:  "Display the title, body, and other information about a pull request.",
 		Run: func(cmd *cobra.Command, args []string) {
 			var id int
 			var err error

diff --git a/cmd/root.go b/cmd/root.go
@@ -14,7 +14,10 @@ import (
 
 var (
 	rootCmd = &cobra.Command{
-		Use: "bb",
+		Use:     "bb",
+		Short:   "Bitbucket.org CLI",
+		Long:    "Work seamlessly with Bitbucket.org from the command line.",
+		Example: `$ bb pr list`,
 		PersistentPreRun: func(cmd *cobra.Command, args []string) {
 			viper.Unmarshal(&globalOpts)
 		},