Skip to content

Commit 24b0795

Browse files
authored
docs: Clarify ListPullRequestsWithCommit usage (#3465)
1 parent a4333f3 commit 24b0795

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

github/pulls.go

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -169,10 +169,12 @@ func (s *PullRequestsService) List(ctx context.Context, owner string, repo strin
169169
return pulls, resp, nil
170170
}
171171

172-
// ListPullRequestsWithCommit returns pull requests associated with a commit SHA.
172+
// ListPullRequestsWithCommit returns pull requests associated with a commit SHA
173+
// or branch name.
173174
//
174-
// The results may include open and closed pull requests.
175-
// By default, the PullRequestListOptions State filters for "open".
175+
// The results may include open and closed pull requests. If the commit SHA is
176+
// not present in the repository's default branch, the result will only include
177+
// open pull requests.
176178
//
177179
// GitHub API docs: https://docs.github.com/rest/commits/commits#list-pull-requests-associated-with-a-commit
178180
//

0 commit comments

Comments
 (0)