From 22bac00148393308716a90271f7fe9653b3b852f Mon Sep 17 00:00:00 2001 From: Azeem Sajid Date: Fri, 7 Feb 2025 21:13:17 +0500 Subject: [PATCH 1/3] [gh pr status] Mention `gh pr checks` in the `Long` section --- pkg/cmd/pr/status/status.go | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/pkg/cmd/pr/status/status.go b/pkg/cmd/pr/status/status.go index 2436934bf..b8d506593 100644 --- a/pkg/cmd/pr/status/status.go +++ b/pkg/cmd/pr/status/status.go @@ -9,6 +9,7 @@ import ( "strconv" "time" + "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/api" ghContext "github.com/cli/cli/v2/context" "github.com/cli/cli/v2/git" @@ -51,7 +52,15 @@ func NewCmdStatus(f *cmdutil.Factory, runF func(*StatusOptions) error) *cobra.Co cmd := &cobra.Command{ Use: "status", Short: "Show status of relevant pull requests", - Args: cmdutil.NoArgsQuoteReminder, + Long: heredoc.Docf(` + Show status of relevant pull requests. + + The status shows a summary of PRs that includes information such as + PR number, title, CI checks, reviews, etc. + + For the details of CI checks, run %[1]sgh pr checks%[1]s. + `, "`"), + Args: cmdutil.NoArgsQuoteReminder, RunE: func(cmd *cobra.Command, args []string) error { // support `-R, --repo` override opts.BaseRepo = f.BaseRepo From b2eec1cd5fd665514abf21ff77c95dc2621cf151 Mon Sep 17 00:00:00 2001 From: Azeem Sajid Date: Fri, 7 Feb 2025 21:15:19 +0500 Subject: [PATCH 2/3] Update language --- pkg/cmd/pr/status/status.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pkg/cmd/pr/status/status.go b/pkg/cmd/pr/status/status.go index b8d506593..3c02eb7b9 100644 --- a/pkg/cmd/pr/status/status.go +++ b/pkg/cmd/pr/status/status.go @@ -58,7 +58,7 @@ func NewCmdStatus(f *cmdutil.Factory, runF func(*StatusOptions) error) *cobra.Co The status shows a summary of PRs that includes information such as PR number, title, CI checks, reviews, etc. - For the details of CI checks, run %[1]sgh pr checks%[1]s. + To see more details of CI checks, run %[1]sgh pr checks%[1]s. `, "`"), Args: cmdutil.NoArgsQuoteReminder, RunE: func(cmd *cobra.Command, args []string) error { From c8a1f8c699289bb43249eee907fcb7c5ef8601bd Mon Sep 17 00:00:00 2001 From: Azeem Sajid Date: Fri, 7 Feb 2025 22:56:00 +0500 Subject: [PATCH 3/3] Update pkg/cmd/pr/status/status.go Co-authored-by: Kynan Ware <47394200+BagToad@users.noreply.github.com> --- pkg/cmd/pr/status/status.go | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pkg/cmd/pr/status/status.go b/pkg/cmd/pr/status/status.go index 3c02eb7b9..b7b390bf2 100644 --- a/pkg/cmd/pr/status/status.go +++ b/pkg/cmd/pr/status/status.go @@ -55,8 +55,8 @@ func NewCmdStatus(f *cmdutil.Factory, runF func(*StatusOptions) error) *cobra.Co Long: heredoc.Docf(` Show status of relevant pull requests. - The status shows a summary of PRs that includes information such as - PR number, title, CI checks, reviews, etc. + The status shows a summary of pull requests that includes information such as + pull request number, title, CI checks, reviews, etc. To see more details of CI checks, run %[1]sgh pr checks%[1]s. `, "`"),