the daily commit (single handedly)

Author: Byron

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

@@ -10,6 +10,10 @@ pub enum Error {
 
 /// Iteration and traversal
 impl Db {
+    /// Return an iterator over all objects contained in the database.
+    ///
+    /// The [`Id`][owned::Id]s returned by the iterator can typically be used in the [`locate(…)`][Db::locate()] method.
+    /// _Note_ that the result is not sorted or stable, thus ordering can change between runs.
     pub fn iter(&self) -> impl Iterator<Item = Result<owned::Id, Error>> {
         use std::path::Component::Normal;
         WalkDir::new(&self.path)

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

@@ -9,6 +9,8 @@ pub struct Db {
 impl Db {
     /// Initialize the Db with the `objects_directory` containing the hexadecimal first byte subdirectories, which in turn
     /// contain all loose objects.
+    ///
+    /// In a git repository, this would be `.git/objects`.
     pub fn at(objects_directory: impl Into<PathBuf>) -> Db {
         Db {
             path: objects_directory.into(),