f - Expand PaymentPathSuccessful::path docs

jkczyz · jkczyz · commit b4a92130c3d8 · 2021-11-22T15:32:21.000-06:00
diff --git a/lightning/src/util/events.rs b/lightning/src/util/events.rs
@@ -356,6 +356,8 @@ pub enum Event {
 		/// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
 		payment_hash: Option<PaymentHash>,
 		/// The payment path that was successful.
+		///
+		/// May contain a closed channel if the HTLC sent along the path was fulfilled on chain.
 		path: Vec<RouteHop>,
 	},
 }

Original file line number	Diff line number	Diff line change
`@@ -356,6 +356,8 @@ pub enum Event {`
`356`	`356`	/// [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
`357`	`357`	`payment_hash: Option<PaymentHash>,`
`358`	`358`	`/// The payment path that was successful.`
	`359`	`+ ///`
	`360`	`+ /// May contain a closed channel if the HTLC sent along the path was fulfilled on chain.`
`359`	`361`	`path: Vec<RouteHop>,`
`360`	`362`	`},`
`361`	`363`	`}`