Skip to content

Commit db87b29

Browse files
Tweak RetryableSendFailure::PaymentExpired docs
This error variant is also used when manually sending to BOLT 12 invoices is enabled, so document that.
1 parent 8331791 commit db87b29

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

Diff for: lightning/src/ln/outbound_payment.rs

+3-1
Original file line numberDiff line numberDiff line change
@@ -458,7 +458,9 @@ impl_writeable_tlv_based_enum_legacy!(StaleExpiration,
458458
/// [`Event::PaymentFailed`]: crate::events::Event::PaymentFailed
459459
#[derive(Clone, Debug, PartialEq, Eq)]
460460
pub enum RetryableSendFailure {
461-
/// The provided [`PaymentParameters::expiry_time`] indicated that the payment has expired.
461+
/// The provided [`PaymentParameters::expiry_time`] indicated that the payment has expired or
462+
/// the BOLT 12 invoice paid to via [`ChannelManager::send_payment_for_bolt12_invoice`] was
463+
/// expired.
462464
#[cfg_attr(feature = "std", doc = "")]
463465
#[cfg_attr(feature = "std", doc = "Note that this error is *not* caused by [`Retry::Timeout`].")]
464466
///

0 commit comments

Comments
 (0)