Merge pull request #1056 from ericswpark/doc-add

ehuss · web-flow · commit b318ea3d2cbf · 2024-05-27T15:17:09.000Z
repo: add branch_upstream_remote refname doc (#1055)
diff --git 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 {

Original file line number	Diff line number	Diff line change
`@@ -3060,6 +3060,8 @@ impl Repository {`
`3060`	`3060`	`}`
`3061`	`3061`
`3062`	`3062`	`/// Retrieve the name of the upstream remote of a local branch.`
	`3063`	`+ ///`
	`3064`	+ /// `refname` must be in the form `refs/heads/{branch_name}`
`3063`	`3065`	`pub fn branch_upstream_remote(&self, refname: &str) -> Result<Buf, Error> {`
`3064`	`3066`	`let refname = CString::new(refname)?;`
`3065`	`3067`	`unsafe {`