From da672f7f846e6e68cc4f2cbc4a7eb0df5a919936 Mon Sep 17 00:00:00 2001 From: Taketoshi Fujiwara Date: Tue, 16 Jun 2020 18:25:12 +0900 Subject: [PATCH] Swap documentation for commitMessage and commitTitle of func (*PullRequestsService) Merge --- github/pulls.go | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/github/pulls.go b/github/pulls.go index 685493f118a..ad372d453f8 100644 --- a/github/pulls.go +++ b/github/pulls.go @@ -439,7 +439,7 @@ type PullRequestMergeResult struct { // PullRequestOptions lets you define how a pull request will be merged. type PullRequestOptions struct { - CommitTitle string // Extra detail to append to automatic commit message. (Optional.) + CommitTitle string // Title for the automatic commit message. (Optional.) SHA string // SHA that pull request head must match to allow merge. (Optional.) // 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 { SHA string `json:"sha,omitempty"` } -// Merge a pull request (Merge Button™). -// commitMessage is the title for the automatic commit message. +// Merge a pull request. +// commitMessage is an extra detail to append to automatic commit message. // -// GitHub API docs: https://developer.github.com/v3/pulls/#merge-a-pull-request-merge-button +// GitHub API docs: https://developer.github.com/v3/pulls/#merge-a-pull-request func (s *PullRequestsService) Merge(ctx context.Context, owner string, repo string, number int, commitMessage string, options *PullRequestOptions) (*PullRequestMergeResult, *Response, error) { u := fmt.Sprintf("repos/%v/%v/pulls/%d/merge", owner, repo, number)