Skip to content

Commit

Permalink
Clarify Retry::Timeout vs PaymentParams::expiry_time in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
valentinewallace committed Feb 23, 2023
1 parent 12bcc9a commit a6e9123
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion lightning/src/ln/outbound_payment.rs
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,10 @@ pub enum Retry {
/// were retried along a route from a single call to [`Router::find_route`].
Attempts(usize),
#[cfg(not(feature = "no-std"))]
/// Time elapsed before abandoning retries for a payment.
/// Time elapsed before abandoning retries for a payment. At least one attempt at payment is made;
/// see [`PaymentParameters::expiry_time`] to avoid any attempt at payment after a specific time.
///
/// [`PaymentParameters::expiry_time`]: crate::routing::router::PaymentParameters::expiry_time
Timeout(core::time::Duration),
}

Expand Down

0 comments on commit a6e9123

Please sign in to comment.