performance note (#470)

Byron · Sep 19, 2022 · 0670468 · 0670468
1 parent 64bbb3d
commit 0670468
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/git-repository/src/object/tree/diff.rs b/git-repository/src/object/tree/diff.rs
@@ -81,6 +81,10 @@ pub mod change {
 /// Diffing
 impl<'repo> Tree<'repo> {
     /// Return a platform to see the changes needed to create other trees, for instance.
+    ///
+    /// # Performance
+    ///
+    /// It's highly recommended to set an object cache to avoid extracting the same object multiple times.
     pub fn changes<'a>(&'a self) -> Platform<'a, 'repo> {
         Platform {
             state: Default::default(),