repository(doc): object_id (#164)

git-repository/src/ext/object_id.rs

@@ -1,16 +1,18 @@
-#![allow(missing_docs)]
 use git_hash::ObjectId;
 use git_traverse::commit::ancestors::{Ancestors, State};
 
 use crate::easy;
 
 pub trait Sealed {}
 
+/// An extension trait to add functionality to [`ObjectId`]s.
 pub trait ObjectIdExt: Sealed {
+    /// Create an iterator over the ancestry of the commits reachable from this id, which must be a commit.
     fn ancestors<Find>(self, find: Find) -> Ancestors<Find, fn(&git_hash::oid) -> bool, State>
     where
         Find: for<'a> FnMut(&git_hash::oid, &'a mut Vec<u8>) -> Option<git_object::CommitRefIter<'a>>;
 
+    /// Infuse this object id with an [`easy::Access`].
     fn attach<A: easy::Access + Sized>(self, access: &A) -> easy::Oid<'_, A>;
 }
 

git-traverse/src/commit.rs

@@ -149,5 +149,6 @@ pub mod ancestors {
         }
     }
 }
+// TODO: put this here as a breaking change.
 #[doc(inline)]
 pub use ancestors::Ancestors;