Merge pull request #106 from jfacchini/select-and-label-cli-doc

Select and Label command documentation

11 files changed, 19 insertions, 10 deletions

diff --git a/commands/comment.go b/commands/comment.go
index 3d5fe4eb..eff91208 100644
--- a/commands/comment.go
+++ b/commands/comment.go
@@ -46,7 +46,7 @@ func commentsTextOutput(comments []bug.Comment) {
 
 var commentCmd = &cobra.Command{
 	Use:     "comment [<id>]",
-	Short:   "Display or add comments.",
+	Short:   "Display or add comments to a bug.",
 	PreRunE: loadRepo,
 	RunE:    runComment,
 }
diff --git a/commands/comment_add.go b/commands/comment_add.go
index 9bb24086..3e153009 100644
--- a/commands/comment_add.go
+++ b/commands/comment_add.go
@@ -56,7 +56,7 @@ func runCommentAdd(cmd *cobra.Command, args []string) error {
 
 var commentAddCmd = &cobra.Command{
 	Use:     "add [<id>]",
-	Short:   "Add a new comment.",
+	Short:   "Add a new comment to a bug.",
 	PreRunE: loadRepo,
 	RunE:    runCommentAdd,
 }
diff --git a/commands/label.go b/commands/label.go
index 4f15c893..a07e9efc 100644
--- a/commands/label.go
+++ b/commands/label.go
@@ -33,7 +33,7 @@ func runLabel(cmd *cobra.Command, args []string) error {
 
 var labelCmd = &cobra.Command{
 	Use:     "label [<id>]",
-	Short:   "Display, add or remove labels.",
+	Short:   "Display, add or remove labels to/from a bug.",
 	PreRunE: loadRepo,
 	RunE:    runLabel,
 }
diff --git a/commands/label_add.go b/commands/label_add.go
index b936bc37..6e2679d9 100644
--- a/commands/label_add.go
+++ b/commands/label_add.go
@@ -37,7 +37,7 @@ func runLabelAdd(cmd *cobra.Command, args []string) error {
 
 var labelAddCmd = &cobra.Command{
 	Use:     "add [<id>] <label>[...]",
-	Short:   "Add a label.",
+	Short:   "Add a label to a bug.",
 	PreRunE: loadRepo,
 	RunE:    runLabelAdd,
 }
diff --git a/commands/label_rm.go b/commands/label_rm.go
index c03a20d9..a0c1c56d 100644
--- a/commands/label_rm.go
+++ b/commands/label_rm.go
@@ -37,7 +37,7 @@ func runLabelRm(cmd *cobra.Command, args []string) error {
 
 var labelRmCmd = &cobra.Command{
 	Use:     "rm [<id>] <label>[...]",
-	Short:   "Remove a label.",
+	Short:   "Remove a label from a bug.",
 	PreRunE: loadRepo,
 	RunE:    runLabelRm,
 }
diff --git a/commands/select.go b/commands/select.go
index 6b214961..efe48b5e 100644
--- a/commands/select.go
+++ b/commands/select.go
@@ -46,6 +46,15 @@ var selectCmd = &cobra.Command{
 git bug comment
 git bug status
 `,
+	Long: `Select a bug for implicit use in future commands.
+
+This command allows you to omit any bug <id> argument, for example:
+  git bug show
+instead of
+  git bug show 2f153ca
+
+The complementary command is "git bug deselect" performing the opposite operation.
+`,
 	PreRunE: loadRepo,
 	RunE:    runSelect,
 }
diff --git a/commands/select/select.go b/commands/select/select.go
index 522cc295..b080d277 100644
--- a/commands/select/select.go
+++ b/commands/select/select.go
@@ -16,7 +16,7 @@ import (
 
 const selectFile = "select"
 
-var ErrNoValidId = errors.New("you must provide a bug id")
+var ErrNoValidId = errors.New("you must provide a bug id or use the \"select\" command first")
 
 // ResolveBug first try to resolve a bug using the first argument of the command
 // line. If it fails, it fallback to the select mechanism.
diff --git a/commands/title.go b/commands/title.go
index f9b7542b..66a9de7a 100644
--- a/commands/title.go
+++ b/commands/title.go
@@ -31,7 +31,7 @@ func runTitle(cmd *cobra.Command, args []string) error {
 
 var titleCmd = &cobra.Command{
 	Use:     "title [<id>]",
-	Short:   "Display or change a title.",
+	Short:   "Display or change a title of a bug.",
 	PreRunE: loadRepo,
 	RunE:    runTitle,
 }
diff --git a/commands/title_edit.go b/commands/title_edit.go
index e95c77d0..385dbdc9 100644
--- a/commands/title_edit.go
+++ b/commands/title_edit.go
@@ -54,7 +54,7 @@ func runTitleEdit(cmd *cobra.Command, args []string) error {
 
 var titleEditCmd = &cobra.Command{
 	Use:     "edit [<id>]",
-	Short:   "Edit a title.",
+	Short:   "Edit a title of a bug.",
 	PreRunE: loadRepo,
 	RunE:    runTitleEdit,
 }
diff --git a/commands/user.go b/commands/user.go
index 12180321..ef5d4991 100644
--- a/commands/user.go
+++ b/commands/user.go
@@ -49,7 +49,7 @@ func runUser(cmd *cobra.Command, args []string) error {
 }
 
 var userCmd = &cobra.Command{
-	Use:     "user [<id>]",
+	Use:     "user [<user-id>]",
 	Short:   "Display or change the user identity.",
 	PreRunE: loadRepo,
 	RunE:    runUser,
diff --git a/commands/user_adopt.go b/commands/user_adopt.go
index 5313e366..d84d4048 100644
--- a/commands/user_adopt.go
+++ b/commands/user_adopt.go
@@ -35,7 +35,7 @@ func runUserAdopt(cmd *cobra.Command, args []string) error {
 }
 
 var userAdoptCmd = &cobra.Command{
-	Use:     "adopt <id>",
+	Use:     "adopt <user-id>",
 	Short:   "Adopt an existing identity as your own.",
 	PreRunE: loadRepo,
 	RunE:    runUserAdopt,