Repository: Add doc comment for head_oid()

Turbo87 · Turbo87 · commit 5ee5b93461c3 · 2021-12-26T11:56:12.000+01:00
diff --git a/src/git.rs b/src/git.rs
@@ -212,6 +212,13 @@ impl Repository {
         }
     }
 
+    /// Returns the [Object ID](git2::Oid) of the currently checked out commit
+    /// in the local crate index repository.
+    ///
+    /// # Errors
+    ///
+    /// - If the `HEAD` pointer can't be retrieved.
+    ///
     pub fn head_oid(&self) -> Result<git2::Oid, PerformError> {
         Ok(self.repository.head()?.target().unwrap())
     }

Original file line number	Diff line number	Diff line change
`@@ -212,6 +212,13 @@ impl Repository {`
`212`	`212`	`}`
`213`	`213`	`}`
`214`	`214`
	`215`	`+ /// Returns the [Object ID](git2::Oid) of the currently checked out commit`
	`216`	`+ /// in the local crate index repository.`
	`217`	`+ ///`
	`218`	`+ /// # Errors`
	`219`	`+ ///`
	`220`	+ /// - If the `HEAD` pointer can't be retrieved.
	`221`	`+ ///`
`215`	`222`	`pub fn head_oid(&self) -> Result<git2::Oid, PerformError> {`
`216`	`223`	`Ok(self.repository.head()?.target().unwrap())`
`217`	`224`	`}`