Renamed user id to user-id and metioned bug for some commands

Jocelyn FACCHINI created 7 years ago

Change summary

commands/comment.go     |  2 +-
commands/comment_add.go |  2 +-
commands/select.go      | 10 ++++------
commands/title.go       |  2 +-
commands/title_edit.go  |  2 +-
commands/user.go        |  2 +-
commands/user_adopt.go  |  2 +-
7 files changed, 10 insertions(+), 12 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/select.go

@@ -48,12 +48,10 @@ git bug status
 `,
 	Long: `Select a bug for implicit use in future commands.
 
-This command allows you to omit any bug <id> argument for the following commands:
-  - git bug comment
-  - git bug label
-  - git bug show
-  - git bug status
-  - git bug title
+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.
 `,

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,