Improve expiry doc

JosephTLyons · Nov 29, 2024 · 9799dc3 · 9799dc3
1 parent 323e224
commit 9799dc3
Showing 1 changed file with 6 additions and 1 deletion.
diff --git a/src/persevero.gleam b/src/persevero.gleam
@@ -137,7 +137,12 @@ pub type Mode {
   /// Specifies the maximum number of attempts to make.
   MaxAttempts(Int)
 
-  /// Specifies the maximum duration to make attempts for.
+  /// Specifies the maximum duration to make attempts for. Note that `Expiry`
+  /// mode does not stop the current wait time from being executed. For example,
+  /// if you're under the expiry timeout by 1s and your next wait time is 10s,
+  /// the next wait time and the operation will still be executed. Also note
+  /// that the duration of the operation is also counted towards the expiry
+  /// timeout.
   Expiry(Int)
 }