diff --git a/command/issue.go b/command/issue.go index 372ad8bd1..814daf3ae 100644 --- a/command/issue.go +++ b/command/issue.go @@ -31,14 +31,14 @@ func init() { issueCreateCmd.Flags().StringP("body", "b", "", "Supply a body. Will prompt for one otherwise.") issueCreateCmd.Flags().BoolP("web", "w", false, "Open the browser to create an issue") - issueCreateCmd.Flags().StringSliceP("assignee", "a", nil, "Assign a person by their `login`") - issueCreateCmd.Flags().StringSliceP("label", "l", nil, "Add a label by `name`") - issueCreateCmd.Flags().StringSliceP("project", "p", nil, "Add the issue to a project by `name`") + issueCreateCmd.Flags().StringSliceP("assignee", "a", nil, "Assign people by their `login`") + issueCreateCmd.Flags().StringSliceP("label", "l", nil, "Add labels by `name`") + issueCreateCmd.Flags().StringSliceP("project", "p", nil, "Add the issue to projects by `name`") issueCreateCmd.Flags().StringP("milestone", "m", "", "Add the issue to a milestone by `name`") issueCmd.AddCommand(issueListCmd) issueListCmd.Flags().StringP("assignee", "a", "", "Filter by assignee") - issueListCmd.Flags().StringSliceP("label", "l", nil, "Filter by label") + issueListCmd.Flags().StringSliceP("label", "l", nil, "Filter by labels") issueListCmd.Flags().StringP("state", "s", "open", "Filter by state: {open|closed|all}") issueListCmd.Flags().IntP("limit", "L", 30, "Maximum number of issues to fetch") issueListCmd.Flags().StringP("author", "A", "", "Filter by author") @@ -70,6 +70,13 @@ var issueCreateCmd = &cobra.Command{ Short: "Create a new issue", Args: cmdutil.NoArgsQuoteReminder, RunE: issueCreate, + Example: heredoc.Doc(` + $ gh issue create --title "I found a bug" --body "Nothing works" + $ gh issue create --label "bug,help wanted" + $ gh issue create --label bug --label "help wanted" + $ gh issue create --assignee monalisa,hubot + $ gh issue create --project "Roadmap" + `), } var issueListCmd = &cobra.Command{ Use: "list", diff --git a/command/pr_create.go b/command/pr_create.go index b96c45391..b2dd48697 100644 --- a/command/pr_create.go +++ b/command/pr_create.go @@ -7,6 +7,7 @@ import ( "strings" "time" + "github.com/MakeNowJust/heredoc" "github.com/cli/cli/api" "github.com/cli/cli/context" "github.com/cli/cli/git" @@ -455,6 +456,14 @@ var prCreateCmd = &cobra.Command{ Short: "Create a pull request", Args: cmdutil.NoArgsQuoteReminder, RunE: prCreate, + Example: heredoc.Doc(` + $ gh pr create --title "The bug is fixed" --body "Everything works again" + $ gh issue create --label "bug,help wanted" + $ gh issue create --label bug --label "help wanted" + $ gh pr create --reviewer monalisa,hubot + $ gh pr create --project "Roadmap" + $ gh pr create --base develop + `), } func init() { @@ -469,9 +478,9 @@ func init() { prCreateCmd.Flags().BoolP("web", "w", false, "Open the web browser to create a pull request") prCreateCmd.Flags().BoolP("fill", "f", false, "Do not prompt for title/body and just use commit info") - prCreateCmd.Flags().StringSliceP("reviewer", "r", nil, "Request a review from someone by their `login`") - prCreateCmd.Flags().StringSliceP("assignee", "a", nil, "Assign a person by their `login`") - prCreateCmd.Flags().StringSliceP("label", "l", nil, "Add a label by `name`") - prCreateCmd.Flags().StringSliceP("project", "p", nil, "Add the pull request to a project by `name`") + prCreateCmd.Flags().StringSliceP("reviewer", "r", nil, "Request reviews from people by their `login`") + prCreateCmd.Flags().StringSliceP("assignee", "a", nil, "Assign people by their `login`") + prCreateCmd.Flags().StringSliceP("label", "l", nil, "Add labels by `name`") + prCreateCmd.Flags().StringSliceP("project", "p", nil, "Add the pull request to projects by `name`") prCreateCmd.Flags().StringP("milestone", "m", "", "Add the pull request to a milestone by `name`") }