Merge pull request #2668 from TheBlueMatt/2023-10-fix-doc
authorvalentinewallace <valentinewallace@users.noreply.github.com>
Mon, 30 Oct 2023 20:21:36 +0000 (16:21 -0400)
committerGitHub <noreply@github.com>
Mon, 30 Oct 2023 20:21:36 +0000 (16:21 -0400)
Update docs on `MonitorEvent::HolderForceClosed`

lightning/src/chain/channelmonitor.rs

index 37c3383a3ad566942efcc965742bb6099c53b5c2..af0f56d882ad591531163df08f9aa05516af92a3 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