Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Improve issue/pr/repo view documentation #764

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Parent: adding --json to pr create - backward compatibility concerns
merged 1 commit into from
Apr 9, 2020
Merged

Improve issue/pr/repo view documentation #764

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions command/issue.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ func init() {
issueListCmd.Flags().StringP("author", "A", "", "Filter by author")

issueCmd.AddCommand(issueViewCmd)
issueViewCmd.Flags().BoolP("web", "w", false, "Open issue in browser")
issueViewCmd.Flags().BoolP("web", "w", false, "Open an issue in the browser")
}

var issueCmd = &cobra.Command{
Expand Down Expand Up @@ -74,7 +74,10 @@ var issueViewCmd = &cobra.Command{
return nil
},
Short: "View an issue",
RunE: issueView,
Long: `Display the title, body, and other information about an issue.

With '--web', open the issue in a web browser instead.`,
RunE: issueView,
}

func issueList(cmd *cobra.Command, args []string) error {
Expand Down
12 changes: 7 additions & 5 deletions command/pr.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ func init() {
prListCmd.Flags().StringSliceP("label", "l", nil, "Filter by label")
prListCmd.Flags().StringP("assignee", "a", "", "Filter by assignee")

prViewCmd.Flags().BoolP("web", "w", false, "Open pull request in browser")
prViewCmd.Flags().BoolP("web", "w", false, "Open a pull request in the browser")
}

var prCmd = &cobra.Command{
Expand All @@ -56,11 +56,13 @@ var prStatusCmd = &cobra.Command{
}
var prViewCmd = &cobra.Command{
Use: "view [{<number> | <url> | <branch>}]",
Short: "View a pull request in the browser",
Long: `View a pull request specified by the argument.
Short: "View a pull request",
Long: `Display the title, body, and other information about a pull request.

Without an argument, the pull request that belongs to the current
branch is displayed.`,
Without an argument, the pull request that belongs to the current branch
is displayed.

With '--web', open the pull request in a web browser instead.`,
RunE: prView,
}

Expand Down
10 changes: 6 additions & 4 deletions command/repo.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ func init() {
repoForkCmd.Flags().Lookup("remote").NoOptDefVal = "true"

repoCmd.AddCommand(repoViewCmd)
repoViewCmd.Flags().BoolP("web", "w", false, "Open repository in browser")
repoViewCmd.Flags().BoolP("web", "w", false, "Open a repository in the browser")
}

var repoCmd = &cobra.Command{
Expand Down Expand Up @@ -80,10 +80,12 @@ With no argument, creates a fork of the current repository. Otherwise, forks the

var repoViewCmd = &cobra.Command{
Use: "view [<repository>]",
Short: "View a repository in the browser",
Long: `View a GitHub repository.
Short: "View a repository",
Long: `Display the description and the README of a GitHub repository.

With no argument, the repository for the current directory is displayed.`,
With no argument, the repository for the current directory is displayed.

With '--web', open the repository in a web browser instead.`,
RunE: repoView,
}

Expand Down