From 1102de89be1f40512201f06b2ff9f8009ee12950 Mon Sep 17 00:00:00 2001 From: Luke Date: Mon, 30 Aug 2021 09:13:43 -0500 Subject: [PATCH] add quotes around @me in documentation to ensure examples work on powershell --- pkg/cmd/issue/create/create.go | 2 +- pkg/cmd/issue/edit/edit.go | 2 +- pkg/cmd/issue/list/list.go | 2 +- pkg/cmd/pr/edit/edit.go | 2 +- pkg/cmd/pr/list/list.go | 4 ++-- 5 files changed, 6 insertions(+), 6 deletions(-) diff --git a/pkg/cmd/issue/create/create.go b/pkg/cmd/issue/create/create.go index 4ef2ab12f..258313b79 100644 --- a/pkg/cmd/issue/create/create.go +++ b/pkg/cmd/issue/create/create.go @@ -62,7 +62,7 @@ func NewCmdCreate(f *cmdutil.Factory, runF func(*CreateOptions) error) *cobra.Co $ gh issue create --label "bug,help wanted" $ gh issue create --label bug --label "help wanted" $ gh issue create --assignee monalisa,hubot - $ gh issue create --assignee @me + $ gh issue create --assignee "@me" $ gh issue create --project "Roadmap" `), Args: cmdutil.NoArgsQuoteReminder, diff --git a/pkg/cmd/issue/edit/edit.go b/pkg/cmd/issue/edit/edit.go index 5e6f0583e..53707e1f2 100644 --- a/pkg/cmd/issue/edit/edit.go +++ b/pkg/cmd/issue/edit/edit.go @@ -50,7 +50,7 @@ func NewCmdEdit(f *cmdutil.Factory, runF func(*EditOptions) error) *cobra.Comman Example: heredoc.Doc(` $ gh issue edit 23 --title "I found a bug" --body "Nothing works" $ gh issue edit 23 --add-label "bug,help wanted" --remove-label "core" - $ gh issue edit 23 --add-assignee @me --remove-assignee monalisa,hubot + $ gh issue edit 23 --add-assignee "@me" --remove-assignee monalisa,hubot $ gh issue edit 23 --add-project "Roadmap" --remove-project v1,v2 $ gh issue edit 23 --milestone "Version 1" $ gh issue edit 23 --body-file body.txt diff --git a/pkg/cmd/issue/list/list.go b/pkg/cmd/issue/list/list.go index b0efd75b7..69a18ae09 100644 --- a/pkg/cmd/issue/list/list.go +++ b/pkg/cmd/issue/list/list.go @@ -57,7 +57,7 @@ func NewCmdList(f *cmdutil.Factory, runF func(*ListOptions) error) *cobra.Comman Example: heredoc.Doc(` $ gh issue list -l "bug" -l "help wanted" $ gh issue list -A monalisa - $ gh issue list -a @me + $ gh issue list -a "@me" $ gh issue list --web $ gh issue list --milestone "The big 1.0" $ gh issue list --search "error no:assignee sort:created-asc" diff --git a/pkg/cmd/pr/edit/edit.go b/pkg/cmd/pr/edit/edit.go index 13481bcba..32b1161bf 100644 --- a/pkg/cmd/pr/edit/edit.go +++ b/pkg/cmd/pr/edit/edit.go @@ -55,7 +55,7 @@ func NewCmdEdit(f *cmdutil.Factory, runF func(*EditOptions) error) *cobra.Comman $ gh pr edit 23 --title "I found a bug" --body "Nothing works" $ gh pr edit 23 --add-label "bug,help wanted" --remove-label "core" $ gh pr edit 23 --add-reviewer monalisa,hubot --remove-reviewer myorg/team-name - $ gh pr edit 23 --add-assignee @me --remove-assignee monalisa,hubot + $ gh pr edit 23 --add-assignee "@me" --remove-assignee monalisa,hubot $ gh pr edit 23 --add-project "Roadmap" --remove-project v1,v2 $ gh pr edit 23 --milestone "Version 1" `), diff --git a/pkg/cmd/pr/list/list.go b/pkg/cmd/pr/list/list.go index b6bce300e..a7dd5886b 100644 --- a/pkg/cmd/pr/list/list.go +++ b/pkg/cmd/pr/list/list.go @@ -51,10 +51,10 @@ func NewCmdList(f *cmdutil.Factory, runF func(*ListOptions) error) *cobra.Comman Short: "List and filter pull requests in this repository", Example: heredoc.Doc(` List PRs authored by you - $ gh pr list --author @me + $ gh pr list --author "@me" List PRs assigned to you - $ gh pr list --assignee @me + $ gh pr list --assignee "@me" List PRs by label, combining multiple labels with AND $ gh pr list --label bug --label "priority 1"