From: Valentine Wallace Date: Thu, 23 Feb 2023 20:49:44 +0000 (-0500) Subject: Clarify Retry::Timeout vs PaymentParams::expiry_time in docs X-Git-Tag: v0.0.114-beta~8^2 X-Git-Url: http://git.bitcoin.ninja/?a=commitdiff_plain;h=a6e9123d3fdfeaa23282ea87d318982ffe041b85;p=rust-lightning Clarify Retry::Timeout vs PaymentParams::expiry_time in docs --- diff --git a/lightning/src/ln/outbound_payment.rs b/lightning/src/ln/outbound_payment.rs index e1c5fa547..1d8d46a91 100644 --- a/lightning/src/ln/outbound_payment.rs +++ b/lightning/src/ln/outbound_payment.rs @@ -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), }