doc: make tree-diff more easily discoverable when coming from git2

Byron · Byron · commit 26748ddbedc2 · 2024-08-20T20:51:28.000+02:00
diff --git a/gix/src/object/tree/diff/change.rs b/gix/src/object/tree/diff/change.rs
@@ -61,7 +61,7 @@ pub enum Event<'a, 'old, 'new> {
         entry_mode: gix_object::tree::EntryMode,
         /// The object id after the rename.
         id: Id<'new>,
-        /// If true, this rewrite is created by copy, and `source_id` is pointing to its source. Otherwise it's a rename, and `source_id`
+        /// If true, this rewrite is created by copy, and `source_id` is pointing to its source. Otherwise, it's a rename, and `source_id`
         /// points to a deleted object, as renames are tracked as deletions and additions of the same or similar content.
         copy: bool,
     },
@@ -70,8 +70,9 @@ pub enum Event<'a, 'old, 'new> {
 impl<'a, 'old, 'new> super::Change<'a, 'old, 'new> {
     /// Produce a platform for performing a line-diff no matter whether the underlying [Event] is an addition, modification,
     /// deletion or rewrite.
-    /// Use `resource_cache` to store the diffable data and possibly reuse previously stored data.
-    /// Afterwards the platform, which holds on to `resource_cache`, can be used to perform ready-made operations on the
+    /// Use `resource_cache` to store the diffable data and possibly reuse previously stored data, usually obtained with
+    /// [crate::Repository::diff_resource_cache()].
+    /// Afterward the platform, which holds on to `resource_cache`, can be used to perform ready-made operations on the
     /// pre-set resources.
     ///
     /// ### Warning about Memory Consumption
diff --git a/gix/src/object/tree/diff/mod.rs b/gix/src/object/tree/diff/mod.rs
@@ -40,6 +40,7 @@ impl<'repo> Tree<'repo> {
     /// try to access blobs to compute a similarity metric. Thus, it's more compatible to turn rewrite tracking off
     /// using [`Platform::track_rewrites()`].
     #[allow(clippy::result_large_err)]
+    #[doc(alias = "diff_tree_to_tree", alias = "git2")]
     pub fn changes<'a>(&'a self) -> Result<Platform<'a, 'repo>, crate::diff::new_rewrites::Error> {
         Ok(Platform {
             state: Default::default(),
