From 3e647385f71a26db1b2cc482500383fdabf1dd28 Mon Sep 17 00:00:00 2001 From: ANKDDEV Date: Fri, 6 Dec 2024 13:45:22 +0300 Subject: [PATCH 1/5] docs: improve docs for browse command as of #5352 --- pkg/cmd/browse/browse.go | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pkg/cmd/browse/browse.go b/pkg/cmd/browse/browse.go index 87ac5826b..5fa3afb02 100644 --- a/pkg/cmd/browse/browse.go +++ b/pkg/cmd/browse/browse.go @@ -59,8 +59,8 @@ func NewCmdBrowse(f *cmdutil.Factory, runF func(*BrowseOptions) error) *cobra.Co } cmd := &cobra.Command{ - Long: "Open the GitHub repository in the web browser.", - Short: "Open the repository in the browser", + Long: "Open the GitHub repository, path inside it, commit, issue or pull request in the web browser.", + Short: "Open the repository, path inside it, issue or PR in the browser", Use: "browse [ | | ]", Args: cobra.MaximumNArgs(1), Example: heredoc.Doc(` From 694e209142b88afa4fdcc77a94fccfdfae87c998 Mon Sep 17 00:00:00 2001 From: ANKDDEV Date: Fri, 6 Dec 2024 16:33:57 +0300 Subject: [PATCH 2/5] docs: improve help for browse command Co-authored-by: Andy Feller --- pkg/cmd/browse/browse.go | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/pkg/cmd/browse/browse.go b/pkg/cmd/browse/browse.go index 5fa3afb02..54a0320c0 100644 --- a/pkg/cmd/browse/browse.go +++ b/pkg/cmd/browse/browse.go @@ -59,8 +59,16 @@ func NewCmdBrowse(f *cmdutil.Factory, runF func(*BrowseOptions) error) *cobra.Co } cmd := &cobra.Command{ - Long: "Open the GitHub repository, path inside it, commit, issue or pull request in the web browser.", - Short: "Open the repository, path inside it, issue or PR in the browser", + Short: "Open repositories, issues, pull requests, and more in the browser", + Long: heredoc.Doc(` + Transition from the terminal to the web browser to view and interact with: + + - issues + - pull requests + - repository content + - repository profile + - repository settings + `), Use: "browse [ | | ]", Args: cobra.MaximumNArgs(1), Example: heredoc.Doc(` From 0e5f26449d82a6571ec4e6f0fc4c515ce0dd43e0 Mon Sep 17 00:00:00 2001 From: ANKDDEV Date: Fri, 6 Dec 2024 19:38:26 +0300 Subject: [PATCH 3/5] docs: update sentence case Co-authored-by: Kynan Ware <47394200+BagToad@users.noreply.github.com> --- pkg/cmd/browse/browse.go | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/pkg/cmd/browse/browse.go b/pkg/cmd/browse/browse.go index 54a0320c0..ec1e99540 100644 --- a/pkg/cmd/browse/browse.go +++ b/pkg/cmd/browse/browse.go @@ -63,11 +63,11 @@ func NewCmdBrowse(f *cmdutil.Factory, runF func(*BrowseOptions) error) *cobra.Co Long: heredoc.Doc(` Transition from the terminal to the web browser to view and interact with: - - issues - - pull requests - - repository content - - repository profile - - repository settings + - Issues + - Pull requests + - Repository content + - Repository profile + - Repository settings `), Use: "browse [ | | ]", Args: cobra.MaximumNArgs(1), From 0653a5a09ce068d39c8472a0a460803bdccdb1ca Mon Sep 17 00:00:00 2001 From: ANKDDEV Date: Fri, 6 Dec 2024 20:04:15 +0300 Subject: [PATCH 4/5] style: reformat files --- pkg/cmd/browse/browse.go | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/pkg/cmd/browse/browse.go b/pkg/cmd/browse/browse.go index ec1e99540..2251dc629 100644 --- a/pkg/cmd/browse/browse.go +++ b/pkg/cmd/browse/browse.go @@ -60,7 +60,7 @@ func NewCmdBrowse(f *cmdutil.Factory, runF func(*BrowseOptions) error) *cobra.Co cmd := &cobra.Command{ Short: "Open repositories, issues, pull requests, and more in the browser", - Long: heredoc.Doc(` + Long: heredoc.Doc(` Transition from the terminal to the web browser to view and interact with: - Issues @@ -69,8 +69,8 @@ func NewCmdBrowse(f *cmdutil.Factory, runF func(*BrowseOptions) error) *cobra.Co - Repository profile - Repository settings `), - Use: "browse [ | | ]", - Args: cobra.MaximumNArgs(1), + Use: "browse [ | | ]", + Args: cobra.MaximumNArgs(1), Example: heredoc.Doc(` $ gh browse #=> Open the home page of the current repository From a4923de755a7d203ee208eec8de7e94c4bdfc4f9 Mon Sep 17 00:00:00 2001 From: ANKDDEV Date: Fri, 6 Dec 2024 20:43:54 +0300 Subject: [PATCH 5/5] docs: update description of command Co-authored-by: Kynan Ware <47394200+BagToad@users.noreply.github.com> --- pkg/cmd/browse/browse.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pkg/cmd/browse/browse.go b/pkg/cmd/browse/browse.go index 2251dc629..f4e3d8fec 100644 --- a/pkg/cmd/browse/browse.go +++ b/pkg/cmd/browse/browse.go @@ -66,7 +66,7 @@ func NewCmdBrowse(f *cmdutil.Factory, runF func(*BrowseOptions) error) *cobra.Co - Issues - Pull requests - Repository content - - Repository profile + - Repository home page - Repository settings `), Use: "browse [ | | ]",