Clarify Retry::Timeout vs PaymentParams::expiry_time in docs
authorValentine Wallace <vwallace@protonmail.com>
Thu, 23 Feb 2023 20:49:44 +0000 (15:49 -0500)
committerValentine Wallace <vwallace@protonmail.com>
Thu, 23 Feb 2023 20:50:25 +0000 (15:50 -0500)
lightning/src/ln/outbound_payment.rs

index e1c5fa547f8ede6903c010c7c8fe846bfa45bf08..1d8d46a916a01cfdfa1cd783df48c7023a6c39e4 100644 (file)
@@ -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),
 }