Update docs for PaymentFailureReason::RouteNotFound

Since we started using this error in send_payment_for_bolt12_invoice, this
error type is no longer only used on retry but also on initial send.

diff --git a/lightning/src/events/mod.rs b/lightning/src/events/mod.rs
index cd4b140ffeb3bf03341aab8cbb59742c23b75463..3538aa3678070df35ddcc52fd6d16d40ec2d2c83 100644 (file)
--- a/lightning/src/events/mod.rs
+++ b/lightning/src/events/mod.rs
@@ -560,11 +560,15 @@ pub enum PaymentFailureReason {
        /// [`PaymentParameters::expiry_time`]: crate::routing::router::PaymentParameters::expiry_time
        /// [`InvoiceRequestExpired`]: Self::InvoiceRequestExpired
        PaymentExpired,
-       /// We failed to find a route while retrying the payment.
+       /// We failed to find a route while sending or retrying the payment.
        ///
        /// Note that this generally indicates that we've exhausted the available set of possible
        /// routes - we tried the payment over a few routes but were not able to find any further
        /// candidate routes beyond those.
+       ///
+       /// Also used for [`BlindedPathCreationFailed`] when downgrading to versions prior to 0.0.124.
+       ///
+       /// [`BlindedPathCreationFailed`]: Self::BlindedPathCreationFailed
        RouteNotFound,
        /// This error should generally never happen. This likely means that there is a problem with
        /// your router.