Skip to content

Commit ecafd12

Browse files
author
Taketoshi Fujiwara
authored
Swap documentation for commitMessage and commitTitle of func (*PullRequestsService) Merge (#1557)
1 parent f9a2213 commit ecafd12

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

github/pulls.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -439,7 +439,7 @@ type PullRequestMergeResult struct {
439439

440440
// PullRequestOptions lets you define how a pull request will be merged.
441441
type PullRequestOptions struct {
442-
CommitTitle string // Extra detail to append to automatic commit message. (Optional.)
442+
CommitTitle string // Title for the automatic commit message. (Optional.)
443443
SHA string // SHA that pull request head must match to allow merge. (Optional.)
444444

445445
// The merge method to use. Possible values include: "merge", "squash", and "rebase" with the default being merge. (Optional.)
@@ -453,10 +453,10 @@ type pullRequestMergeRequest struct {
453453
SHA string `json:"sha,omitempty"`
454454
}
455455

456-
// Merge a pull request (Merge Button™).
457-
// commitMessage is the title for the automatic commit message.
456+
// Merge a pull request.
457+
// commitMessage is an extra detail to append to automatic commit message.
458458
//
459-
// GitHub API docs: https://developer.github.com/v3/pulls/#merge-a-pull-request-merge-button
459+
// GitHub API docs: https://developer.github.com/v3/pulls/#merge-a-pull-request
460460
func (s *PullRequestsService) Merge(ctx context.Context, owner string, repo string, number int, commitMessage string, options *PullRequestOptions) (*PullRequestMergeResult, *Response, error) {
461461
u := fmt.Sprintf("repos/%v/%v/pulls/%d/merge", owner, repo, number)
462462

0 commit comments

Comments
 (0)