refactor (#26)

- typos and form
- improve docs and docs consistency.

Author: Byron

src/index/diff/delegate.rs

@@ -61,11 +61,12 @@ impl Delegate {
                 if let Some(obj) = entry_data(entry_mode, id)? {
                     for line in obj.data.lines() {
                         let version = version_from_json_line(line, change.location)?;
-                        if version.yanked {
-                            self.changes.push(Change::AddedAndYanked(version));
+                        let change = if version.yanked {
+                            Change::AddedAndYanked(version)
                         } else {
-                            self.changes.push(Change::Added(version));
-                        }
+                            Change::Added(version)
+                        };
+                        self.changes.push(change)
                     }
                 }
             }
@@ -86,7 +87,7 @@ impl Delegate {
                 if let Some(diff) = change.event.diff().transpose()? {
                     let location = change.location;
                     for line in diff.old.data.lines() {
-                        // Safety: We transfort an &'_ [u8] to and &'static [u8] here
+                        // Safety: We transform an &'_ [u8] to and &'static [u8] here
                         // this is safe because we always drain the hashmap at the end of the function
                         // the reason the HashMap has a static is that we want to reuse
                         // the allocation for modifications
@@ -127,11 +128,12 @@ impl Delegate {
                         })
                     }
                     for ChecksumWithVersion(version) in self.temporary_version_map.drain() {
-                        if version.yanked {
-                            self.changes.push(Change::AddedAndYanked(version))
+                        let change = if version.yanked {
+                            Change::AddedAndYanked(version)
                         } else {
-                            self.changes.push(Change::Added(version))
-                        }
+                            Change::Added(version)
+                        };
+                        self.changes.push(change);
                     }
                 }
             }

src/index/diff/mod.rs

@@ -173,7 +173,7 @@ impl Index {
     /// The order of the changes for each crate are **non-deterministic**.
     /// The order of crates is also **non-deterministic**.
     ///
-    /// If a specific order is required, the changes must be sorted by the calle
+    /// If a specific order is required, the changes must be sorted by the caller.
     pub fn changes_between_commits(
         &self,
         from: impl Into<git::hash::ObjectId>,
@@ -256,7 +256,7 @@ impl Index {
     /// The order of the changes for each crate are **non-deterministic**.
     /// The order of crates is also **non-deterministic**.
     ///
-    /// If a specific order is required, the changes must be sorted by the calle
+    /// If a specific order is required, the changes must be sorted by the caller.
     pub fn changes(
         &self,
         from: impl AsRef<str>,

src/types.rs

@@ -22,11 +22,14 @@ pub struct Index {
 /// Identify a kind of change that occurred to a crate
 #[derive(Clone, Eq, PartialEq, Debug)]
 pub enum Change {
-    /// A crate version was added
+    /// A crate version was added.
     Added(CrateVersion),
     /// A crate version was unyanked.
     Unyanked(CrateVersion),
-    /// A crate version was unyanked.
+    /// A crate version was added in a yanked state.
+    ///
+    /// This can happen if we don't see the commit that added them, so it appears to pop into existence yanked.
+    /// Knowing this should help to trigger the correct action, as simply `Yanked` crates would be treated quite differently.
     AddedAndYanked(CrateVersion),
     /// A crate version was yanked.
     Yanked(CrateVersion),
@@ -72,10 +75,11 @@ impl Change {
         }
     }
 
-    /// Returns all versions affacted by this change
-    /// The returned slice usually has length 1
-    /// However if a crate was purged from the index by an admin,
-    /// all versions of the pruged crate are returned
+    /// Returns all versions affected by this change.
+    ///
+    /// The returned slice usually has length 1.
+    /// However, if a crate was purged from the index by an admin,
+    /// all versions of the purged crate are returned.
     pub fn versions(&self) -> &[CrateVersion] {
         match self {
             Change::Added(v)