Merge pull request cli#141 from github/add-url-branch-to-usage

probablycorey · web-flow · commit 4de0a76234f6 · 2019-12-06T14:39:43.000-08:00
Add better usage docs for `gh pr view` `gh pr checkout` `gh issue view`
diff --git a/command/issue.go b/command/issue.go
@@ -30,14 +30,18 @@ func init() {
 	issueCmd.AddCommand(issueListCmd)
 	issueListCmd.Flags().StringP("assignee", "a", "", "Filter by assignee")
 	issueListCmd.Flags().StringSliceP("label", "l", nil, "Filter by label")
-	issueListCmd.Flags().StringP("state", "s", "", "Filter by state (open|closed|all)")
+	issueListCmd.Flags().StringP("state", "s", "", "Filter by state: {open|closed|all}")
 	issueListCmd.Flags().IntP("limit", "L", 30, "Maximum number of issues to fetch")
 }
 
 var issueCmd = &cobra.Command{
 	Use:   "issue",
 	Short: "Create and view issues",
-	Long:  `Work with GitHub issues`,
+	Long: `Work with GitHub issues.
+
+An issue can be supplied as argument in any of the following formats:
+- by number, e.g. "123"; or
+- by URL, e.g. "https://github.com/<owner>/<repo>/issues/123".`,
 }
 var issueCreateCmd = &cobra.Command{
 	Use:   "create",
@@ -55,7 +59,7 @@ var issueStatusCmd = &cobra.Command{
 	RunE:  issueStatus,
 }
 var issueViewCmd = &cobra.Command{
-	Use:   "view <issue-number>",
+	Use:   "view {<number> | <url> | <branch>}",
 	Args:  cobra.MinimumNArgs(1),
 	Short: "View an issue in the browser",
 	RunE:  issueView,
diff --git a/command/pr.go b/command/pr.go
@@ -25,7 +25,7 @@ func init() {
 	prCmd.AddCommand(prViewCmd)
 
 	prListCmd.Flags().IntP("limit", "L", 30, "Maximum number of items to fetch")
-	prListCmd.Flags().StringP("state", "s", "open", "Filter by state")
+	prListCmd.Flags().StringP("state", "s", "open", "Filter by state: {open|closed|merged|all}")
 	prListCmd.Flags().StringP("base", "B", "", "Filter by base branch")
 	prListCmd.Flags().StringSliceP("label", "l", nil, "Filter by label")
 	prListCmd.Flags().StringP("assignee", "a", "", "Filter by assignee")
@@ -34,10 +34,15 @@ func init() {
 var prCmd = &cobra.Command{
 	Use:   "pr",
 	Short: "Create, view, and checkout pull requests",
-	Long:  `Work with GitHub pull requests.`,
+	Long: `Work with GitHub pull requests.
+
+A pull request can be supplied as argument in any of the following formats:
+- by number, e.g. "123";
+- by URL, e.g. "https://github.com/<owner>/<repo>/pull/123"; or
+- by the name of its head branch, e.g. "patch-1" or "<owner>:patch-1".`,
 }
 var prCheckoutCmd = &cobra.Command{
-	Use:   "checkout <pr-number>",
+	Use:   "checkout {<number> | <url> | <branch>}",
 	Short: "Check out a pull request in Git",
 	Args:  cobra.MinimumNArgs(1),
 	RunE:  prCheckout,
@@ -53,7 +58,7 @@ var prStatusCmd = &cobra.Command{
 	RunE:  prStatus,
 }
 var prViewCmd = &cobra.Command{
-	Use:   "view [pr-number]",
+	Use:   "view {<number> | <url> | <branch>}",
 	Short: "View a pull request in the browser",
 	RunE:  prView,
 }
