Merge pull request #2915 from TheBlueMatt/2024-02-better-rnf-docs

Update docs on `PaymentFailureReason::RouteNotFound` to add context
lightningdevkit · Feb 29, 2024 · cfb4391 · cfb4391
2 parents 337b8de + a647883
commit cfb4391
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/lightning/src/events/mod.rs b/lightning/src/events/mod.rs
@@ -368,6 +368,10 @@ pub enum PaymentFailureReason {
 	/// [`PaymentParameters::expiry_time`]: crate::routing::router::PaymentParameters::expiry_time
 	PaymentExpired,
 	/// We failed to find a route while 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.
 	RouteNotFound,
 	/// This error should generally never happen. This likely means that there is a problem with
 	/// your router.