Skip to content

Commit a6e9123

Browse files
Clarify Retry::Timeout vs PaymentParams::expiry_time in docs
1 parent 12bcc9a commit a6e9123

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

lightning/src/ln/outbound_payment.rs

+4-1
Original file line numberDiff line numberDiff line change
@@ -235,7 +235,10 @@ pub enum Retry {
235235
/// were retried along a route from a single call to [`Router::find_route`].
236236
Attempts(usize),
237237
#[cfg(not(feature = "no-std"))]
238-
/// Time elapsed before abandoning retries for a payment.
238+
/// Time elapsed before abandoning retries for a payment. At least one attempt at payment is made;
239+
/// see [`PaymentParameters::expiry_time`] to avoid any attempt at payment after a specific time.
240+
///
241+
/// [`PaymentParameters::expiry_time`]: crate::routing::router::PaymentParameters::expiry_time
239242
Timeout(core::time::Duration),
240243
}
241244

0 commit comments

Comments
 (0)