From 736163c8d374a96974773140cf10e27b5df44c5b Mon Sep 17 00:00:00 2001
From: Samuel Tardieu <sam@rfc1149.net>
Date: Sun, 22 Sep 2024 22:07:17 +0200
Subject: [PATCH] repo: add `MutableRepo::rebase_descendants` documentation

---
 lib/src/repo.rs | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/lib/src/repo.rs b/lib/src/repo.rs
index 10da444d6..4c5f57c65 100644
--- a/lib/src/repo.rs
+++ b/lib/src/repo.rs
@@ -1314,6 +1314,11 @@ impl MutableRepo {
         result
     }
 
+    /// Rebase descendants of the rewritten commits.
+    ///
+    /// The descendants of the commits registered in `self.parent_mappings` will
+    /// be recursively rebased onto the new version of their parents.
+    /// Returns the number of rebased descendants.
     pub fn rebase_descendants(&mut self, settings: &UserSettings) -> BackendResult<usize> {
         let roots = self.parent_mapping.keys().cloned().collect_vec();
         let mut num_rebased = 0;