Repository: Add doc comment for reset_head()

Turbo87 · Turbo87 · commit a8d5bcac29cf · 2021-12-26T12:02:53.000+01:00
diff --git a/src/git.rs b/src/git.rs
@@ -294,6 +294,8 @@ impl Repository {
             })
     }
 
+    /// Fetches any changes from the `origin` remote and performs a hard reset
+    /// to the tip of the `origin/master` branch.
     pub fn reset_head(&self) -> Result<(), PerformError> {
         let mut origin = self.repository.find_remote("origin")?;
         let original_head = self.head_oid()?;

Original file line number	Diff line number	Diff line change
`@@ -294,6 +294,8 @@ impl Repository {`
`294`	`294`	`})`
`295`	`295`	`}`
`296`	`296`
	`297`	+ /// Fetches any changes from the `origin` remote and performs a hard reset
	`298`	+ /// to the tip of the `origin/master` branch.
`297`	`299`	`pub fn reset_head(&self) -> Result<(), PerformError> {`
`298`	`300`	`let mut origin = self.repository.find_remote("origin")?;`
`299`	`301`	`let original_head = self.head_oid()?;`