Skip to content

Commit b046d20

Browse files
authored
Merge pull request cli#13021 from joshjohanning/add-reviewer-re-request-docs
docs: clarify that `gh pr edit --add-reviewer` can re-request reviews
2 parents 8723e3b + 761229f commit b046d20

File tree

1 file changed

+21
-2
lines changed

1 file changed

+21
-2
lines changed

pkg/cmd/pr/edit/edit.go

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,12 +74,31 @@ func NewCmdEdit(f *cmdutil.Factory, runF func(*EditOptions) error) *cobra.Comman
7474
- %[1]s@copilot%[1]s: request or remove review from Copilot (not supported on GitHub Enterprise Server)
7575
`, "`"),
7676
Example: heredoc.Doc(`
77+
# Edit the title and body of a pull request
7778
$ gh pr edit 23 --title "I found a bug" --body "Nothing works"
79+
80+
# Use a file as the body
81+
$ gh pr edit 23 --body-file body.txt
82+
83+
# Manage labels
7884
$ gh pr edit 23 --add-label "bug,help wanted" --remove-label "core"
79-
$ gh pr edit 23 --add-reviewer monalisa,hubot --remove-reviewer myorg/team-name
85+
86+
# Manage reviewers
87+
$ gh pr edit 23 --add-reviewer monalisa,hubot --remove-reviewer myorg/team-name
88+
89+
# Re-request review
90+
$ gh pr edit 23 --add-reviewer monalisa
91+
92+
# Request a review from GitHub Copilot
8093
$ gh pr edit 23 --add-reviewer "@copilot"
94+
95+
# Manage assignees
8196
$ gh pr edit 23 --add-assignee "@me" --remove-assignee monalisa,hubot
97+
98+
# Assign GitHub Copilot
8299
$ gh pr edit 23 --add-assignee "@copilot"
100+
101+
# Manage projects and milestones
83102
$ gh pr edit 23 --add-project "Roadmap" --remove-project v1,v2
84103
$ gh pr edit 23 --milestone "Version 1"
85104
$ gh pr edit 23 --remove-milestone
@@ -190,7 +209,7 @@ func NewCmdEdit(f *cmdutil.Factory, runF func(*EditOptions) error) *cobra.Comman
190209
cmd.Flags().StringVarP(&opts.Editable.Body.Value, "body", "b", "", "Set the new body.")
191210
cmd.Flags().StringVarP(&bodyFile, "body-file", "F", "", "Read body text from `file` (use \"-\" to read from standard input)")
192211
cmd.Flags().StringVarP(&opts.Editable.Base.Value, "base", "B", "", "Change the base `branch` for this pull request")
193-
cmd.Flags().StringSliceVar(&opts.Editable.Reviewers.Add, "add-reviewer", nil, "Add reviewers by their `login`. Use \"@copilot\" to request review from Copilot.")
212+
cmd.Flags().StringSliceVar(&opts.Editable.Reviewers.Add, "add-reviewer", nil, "Add or re-request reviewers by their `login`. Use \"@copilot\" to request review from Copilot.")
194213
cmd.Flags().StringSliceVar(&opts.Editable.Reviewers.Remove, "remove-reviewer", nil, "Remove reviewers by their `login`. Use \"@copilot\" to remove review request from Copilot.")
195214
cmd.Flags().StringSliceVar(&opts.Editable.Assignees.Add, "add-assignee", nil, "Add assigned users by their `login`. Use \"@me\" to assign yourself, or \"@copilot\" to assign Copilot.")
196215
cmd.Flags().StringSliceVar(&opts.Editable.Assignees.Remove, "remove-assignee", nil, "Remove assigned users by their `login`. Use \"@me\" to unassign yourself, or \"@copilot\" to unassign Copilot.")

0 commit comments

Comments
 (0)