From 854edb5c391520e4b1dfef96b8ded78159972c65 Mon Sep 17 00:00:00 2001 From: Michael Meng Date: Tue, 14 Dec 2021 15:30:24 -0800 Subject: [PATCH] update comment on ListPullRequestsWithCommit --- github/pulls.go | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/github/pulls.go b/github/pulls.go index 6c866ea8840..37fb7413a4c 100644 --- a/github/pulls.go +++ b/github/pulls.go @@ -167,9 +167,10 @@ func (s *PullRequestsService) List(ctx context.Context, owner string, repo strin // ListPullRequestsWithCommit returns pull requests associated with a commit SHA. // -// The results will include open and closed pull requests. +// The results may include open and closed pull requests. +// By default, the PullRequestListOptions State filters for "open". // -// GitHub API docs: https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#list-pull-requests-associated-with-a-commit +// GitHub API docs: https://docs.github.com/en/free-pro-team@latest/rest/reference/commits/#list-pull-requests-associated-with-a-commit func (s *PullRequestsService) ListPullRequestsWithCommit(ctx context.Context, owner, repo, sha string, opts *PullRequestListOptions) ([]*PullRequest, *Response, error) { u := fmt.Sprintf("repos/%v/%v/commits/%v/pulls", owner, repo, sha) u, err := addOptions(u, opts)