Skip to content

Commit 5f496dd

Browse files
Add doc for NewPullRequest (#3208)
1 parent 4583e71 commit 5f496dd

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

github/pulls.go

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -250,9 +250,16 @@ func (s *PullRequestsService) GetRaw(ctx context.Context, owner string, repo str
250250

251251
// NewPullRequest represents a new pull request to be created.
252252
type NewPullRequest struct {
253-
Title *string `json:"title,omitempty"`
254-
Head *string `json:"head,omitempty"`
255-
HeadRepo *string `json:"head_repo,omitempty"`
253+
Title *string `json:"title,omitempty"`
254+
// The name of the branch where your changes are implemented. For
255+
// cross-repository pull requests in the same network, namespace head with
256+
// a user like this: username:branch.
257+
Head *string `json:"head,omitempty"`
258+
HeadRepo *string `json:"head_repo,omitempty"`
259+
// The name of the branch you want the changes pulled into. This should be
260+
// an existing branch on the current repository. You cannot submit a pull
261+
// request to one repository that requests a merge to a base of another
262+
// repository.
256263
Base *string `json:"base,omitempty"`
257264
Body *string `json:"body,omitempty"`
258265
Issue *int `json:"issue,omitempty"`

0 commit comments

Comments
 (0)