doc: fix PullRequestRefs comment

This commit is contained in:
Kynan Ware 2025-02-24 13:13:56 -07:00
parent 6dbb3fe541
commit b61b2298d2

View file

@ -99,10 +99,10 @@ type FindOptions struct {
// TODO: Does this also need the BaseBranchName?
// PR's are represented by the following:
// baseRef -----PR-----> headRef
// headRef -----PR-----> baseRef
//
// A ref is described as "remoteName/branchName", so
// baseRepoName/baseBranchName -----PR-----> headRepoName/headBranchName
// headRepoName/headBranchName -----PR-----> baseRepoName/baseBranchName
type PullRequestRefs struct {
BranchName string
HeadRepo ghrepo.Interface