some more documentation

Author: Byron

git-odb/src/loose/db/locate.rs

@@ -25,6 +25,9 @@ pub enum Error {
 impl Db {
     const OPEN_ACTION: &'static str = "open";
 
+    /// Return the object identified by the given [`id][borrowed::Id] if present in this database.
+    ///
+    /// Returns `None` if the object did not exist in the database.
     pub fn locate(&self, id: borrowed::Id<'_>) -> Option<Result<Object, Error>> {
         match self.locate_inner(id) {
             Ok(obj) => Some(Ok(obj)),

git-odb/src/loose/db/write.rs

@@ -24,6 +24,9 @@ pub enum Error {
 impl crate::Write for Db {
     type Error = Error;
 
+    /// Write the given buffer in `from` to disk in one syscall at best.
+    ///
+    /// This will cost at least 4 IO operations.
     fn write_buf(&self, kind: git_object::Kind, from: &[u8], hash: HashKind) -> Result<owned::Id, Self::Error> {
         match hash {
             HashKind::Sha1 => {
@@ -39,6 +42,9 @@ impl crate::Write for Db {
         }
     }
 
+    /// Write the given stream in `from` to disk with at least one syscall.
+    ///
+    /// This will cost at least 4 IO operations.
     fn write_stream(
         &self,
         kind: git_object::Kind,