Update docs on `MonitorEvent::HolderForceClosed` 2023-10-fix-doc
authorMatt Corallo <git@bluematt.me>
Tue, 17 Oct 2023 16:23:20 +0000 (16:23 +0000)
committerMatt Corallo <git@bluematt.me>
Fri, 20 Oct 2023 16:00:49 +0000 (16:00 +0000)
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.

lightning/src/chain/channelmonitor.rs

index bd0c15484283b5a12d0c815d13afb9310acb688e..b959ff841d2a843497eece71b7bfe0335efe9035 100644 (file)
@@ -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