From c2c28f211b636f256edcbff19264b6945ee150e9 Mon Sep 17 00:00:00 2001
From: Joonas Koivunen <joonas@neon.tech>
Date: Thu, 25 Jul 2024 09:04:00 +0000
Subject: [PATCH] doc: explain returning option

---
 pageserver/src/tenant/remote_timeline_client/index.rs | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/pageserver/src/tenant/remote_timeline_client/index.rs b/pageserver/src/tenant/remote_timeline_client/index.rs
index c3f54e4c7e..850ea711b9 100644
--- a/pageserver/src/tenant/remote_timeline_client/index.rs
+++ b/pageserver/src/tenant/remote_timeline_client/index.rs
@@ -300,7 +300,8 @@ impl GcBlocking {
         self.clone()
     }
 
-    /// Returns a version of self without the reason of detach_ancestor.
+    /// Returns a version of self without the reason of detach_ancestor. Assumption is that if
+    /// there are no more reasons, we can unblock the gc.
     pub(super) fn without_detach_ancestor(&self) -> Option<Self> {
         None
     }