From: Matt Corallo <git@bluematt.me>
Date: Tue, 17 Oct 2023 16:23:20 +0000 (+0000)
Subject: Update docs on `MonitorEvent::HolderForceClosed`
X-Git-Tag: v0.0.119~69^2
X-Git-Url: http://git.bitcoin.ninja/?a=commitdiff_plain;h=refs%2Fheads%2F2023-10-fix-doc;p=rust-lightning

Update docs on `MonitorEvent::HolderForceClosed`

In a96e2fe144383ea6fd670153fb895ee07a3245ef we renamed
`MonitorEvent::CommitmentTxConfirmed` to `HolderForceClosed` to
better document what actually happened. However, we failed to
update the documentation on the type, which we do here.

Pointed out by @yellowred.
---

diff --git a/lightning/src/chain/channelmonitor.rs b/lightning/src/chain/channelmonitor.rs
index bd0c15484..b959ff841 100644
--- a/lightning/src/chain/channelmonitor.rs
+++ b/lightning/src/chain/channelmonitor.rs
@@ -132,7 +132,8 @@ pub enum MonitorEvent {
 	/// A monitor event containing an HTLCUpdate.
 	HTLCEvent(HTLCUpdate),
 
-	/// A monitor event that the Channel's commitment transaction was confirmed.
+	/// Indicates we broadcasted the channel's latest commitment transaction and thus closed the
+	/// channel.
 	HolderForceClosed(OutPoint),
 
 	/// Indicates a [`ChannelMonitor`] update has completed. See