Skip to content

Commit fef3638

Browse files
authored
Update comment on ListPullRequestsWithCommit (#2228)
1 parent ff33a55 commit fef3638

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

github/pulls.go

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -167,9 +167,10 @@ func (s *PullRequestsService) List(ctx context.Context, owner string, repo strin
167167

168168
// ListPullRequestsWithCommit returns pull requests associated with a commit SHA.
169169
//
170-
// The results will include open and closed pull requests.
170+
// The results may include open and closed pull requests.
171+
// By default, the PullRequestListOptions State filters for "open".
171172
//
172-
// GitHub API docs: https://docs.github.com/en/free-pro-team@latest/rest/reference/repos/#list-pull-requests-associated-with-a-commit
173+
// GitHub API docs: https://docs.github.com/en/free-pro-team@latest/rest/reference/commits/#list-pull-requests-associated-with-a-commit
173174
func (s *PullRequestsService) ListPullRequestsWithCommit(ctx context.Context, owner, repo, sha string, opts *PullRequestListOptions) ([]*PullRequest, *Response, error) {
174175
u := fmt.Sprintf("repos/%v/%v/commits/%v/pulls", owner, repo, sha)
175176
u, err := addOptions(u, opts)

0 commit comments

Comments
 (0)