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

Michael Muré created 6 years ago

Select and Label command documentation

Change summary

commands/comment.go       | 2 +-
commands/comment_add.go   | 2 +-
commands/label.go         | 2 +-
commands/label_add.go     | 2 +-
commands/label_rm.go      | 2 +-
commands/select.go        | 9 +++++++++
commands/select/select.go | 2 +-
commands/title.go         | 2 +-
commands/title_edit.go    | 2 +-
commands/user.go          | 2 +-
commands/user_adopt.go    | 2 +-
11 files changed, 19 insertions(+), 10 deletions(-)

Detailed changes

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,
 }

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,
 }

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,
 }

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,
 }

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,
 }

commands/select.go

@@ -45,6 +45,15 @@ var selectCmd = &cobra.Command{
 	Example: `git bug select 2f15
 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,

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.

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,
 }

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,
 }

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,

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,