From 028caa3823c60c5752c73b9c03c94db3f3f8163b Mon Sep 17 00:00:00 2001
From: Kynan Ware <47394200+BagToad@users.noreply.github.com>
Date: Wed, 12 Mar 2025 12:11:15 -0600
Subject: [PATCH] docs(pr create): clarify BaseRepo type in submitPR

---
 pkg/cmd/pr/create/create.go | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/pkg/cmd/pr/create/create.go b/pkg/cmd/pr/create/create.go
index 646e58abd..8ea0b48db 100644
--- a/pkg/cmd/pr/create/create.go
+++ b/pkg/cmd/pr/create/create.go
@@ -812,6 +812,8 @@ func submitPR(opts CreateOptions, ctx CreateContext, state shared.IssueMetadataS
 	}
 
 	opts.IO.StartProgressIndicator()
+	// At this point, ctx.PrRefs.BaseRepo is guaranteed to be an *api.Repository
+	// because of https://github.com/cli/cli/blob/d29db2d44199ad4a987ea866f3f4ff601b1c90a0/pkg/cmd/pr/create/create.go#L578-L592
 	pr, err := api.CreatePullRequest(client, ctx.PrRefs.BaseRepo.(*api.Repository), params)
 	opts.IO.StopProgressIndicator()
 	if pr != nil {