From cd787070f6262d5f9fc301db514076c2b56e88b6 Mon Sep 17 00:00:00 2001
From: Joonas Koivunen <joonas@neon.tech>
Date: Wed, 10 May 2023 16:25:07 +0300
Subject: [PATCH] fixup: doc: explain convoluted return type

---
 libs/utils/src/shared_retryable.rs | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/libs/utils/src/shared_retryable.rs b/libs/utils/src/shared_retryable.rs
index 5e08663952..539db986c1 100644
--- a/libs/utils/src/shared_retryable.rs
+++ b/libs/utils/src/shared_retryable.rs
@@ -219,6 +219,8 @@ where
         }
     }
 
+    /// Returns a Ok if the previous attempt had resulted in a terminal result. Err is returned
+    /// when an attempt can be joined and possibly needs to be spawned.
     async fn decide_to_retry_or_join<F, Fut, E2>(
         &self,
         retry_with: F,