repository(doc): easy::object::errors (#164)

GitoxideLabs · Sep 13, 2021 · de004b3 · de004b3
1 parent 61793ff
commit de004b3
Showing 1 changed file with 8 additions and 1 deletion.
diff --git a/git-repository/src/easy/object/errors.rs b/git-repository/src/easy/object/errors.rs
@@ -1,12 +1,13 @@
-#![allow(missing_docs)]
 ///
 pub mod find {
 
     use crate::easy;
 
     pub(crate) type OdbError = git_odb::compound::find::Error;
 
+    /// The error returned by [`ObjectAccessExt::try_find_object()`][easy::ext::ObjectAccessExt::try_find_object()].
     #[derive(Debug, thiserror::Error)]
+    #[allow(missing_docs)]
     pub enum Error {
         #[error(transparent)]
         Find(#[from] OdbError),
@@ -16,12 +17,15 @@ pub mod find {
         BorrowRepo(#[from] easy::borrow::repo::Error),
     }
 
+    ///
     pub mod existing {
         use crate::easy;
 
         pub(crate) type OdbError = git_odb::pack::find::existing::Error<git_odb::compound::find::Error>;
 
+        /// The error returned by [`ObjectAccessExt::find_object()`][easy::ext::ObjectAccessExt::find_object()].
         #[derive(Debug, thiserror::Error)]
+        #[allow(missing_docs)]
         pub enum Error {
             #[error(transparent)]
             FindExisting(#[from] OdbError),
@@ -33,10 +37,13 @@ pub mod find {
     }
 }
 
+///
 pub mod write {
     use crate::easy;
 
+    /// The error returned by [`ObjectAccessExt::write_object()`][easy::ext::ObjectAccessExt::write_object()].
     #[derive(Debug, thiserror::Error)]
+    #[allow(missing_docs)]
     pub enum Error {
         #[error(transparent)]
         OdbWrite(#[from] git_odb::loose::write::Error),