From: Matt Corallo <git@bluematt.me>
Date: Fri, 5 May 2023 04:08:55 +0000 (+0000)
Subject: Docuemnt when `PaymentPathFailed::payment_id` is `Some`
X-Git-Tag: v0.0.116-alpha1~49^2
X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=commitdiff_plain;h=refs%2Fheads%2F2023-05-doc-events-present;p=rust-lightning

Docuemnt when `PaymentPathFailed::payment_id` is `Some`

The `PaymentPathFailed::payment_id` field has been `Some` since
the field was added in
73f601fd3d1c9defe553392264ca6dbcc53e4334.
---

diff --git a/lightning/src/events/mod.rs b/lightning/src/events/mod.rs
index 046eb22f7..665fd0ed2 100644
--- a/lightning/src/events/mod.rs
+++ b/lightning/src/events/mod.rs
@@ -520,6 +520,8 @@ pub enum Event {
 	PaymentPathFailed {
 		/// The `payment_id` passed to [`ChannelManager::send_payment`].
 		///
+		/// This will be `Some` for all payment paths which failed on LDK 0.0.103 or later.
+		///
 		/// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
 		/// [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
 		payment_id: Option<PaymentId>,