Skip to content

Commit

Permalink
Improve expiry doc
Browse files Browse the repository at this point in the history
  • Loading branch information
JosephTLyons committed Nov 29, 2024
1 parent 323e224 commit 3e3fcc4
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions src/persevero.gleam
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,13 @@ pub type Mode {
MaxAttempts(Int)

/// 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, resulting in spillover. Also note that the duration of the
/// operation is taken into account when calculating the total duration
/// elapsed.
Expiry(Int)
}

Expand Down

0 comments on commit 3e3fcc4

Please sign in to comment.