From 79b1bed394b0476c81f51e9a5d6ffe83523e283b Mon Sep 17 00:00:00 2001
From: Eric Park <me@ericswpark.com>
Date: Mon, 27 May 2024 14:19:09 +0900
Subject: [PATCH] repo: add branch_upstream_remote refname doc (#1055)

Adds the full refname format for the documentation

Closes #1055
---
 src/repo.rs | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/src/repo.rs b/src/repo.rs
index db00545e4f..b94b4007db 100644
--- a/src/repo.rs
+++ b/src/repo.rs
@@ -3060,6 +3060,8 @@ impl Repository {
     }
 
     /// Retrieve the name of the upstream remote of a local branch.
+    ///
+    /// `refname` must be in the form `refs/heads/{branch_name}`
     pub fn branch_upstream_remote(&self, refname: &str) -> Result<Buf, Error> {
         let refname = CString::new(refname)?;
         unsafe {