Update docs on MonitorEvent::HolderForceClosed

In a96e2fe144 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.
This commit is contained in:
Matt Corallo 2023-10-17 16:23:20 +00:00
parent 9de51f0bee
commit 323366cfd3

View file

@ -132,7 +132,8 @@ pub enum MonitorEvent {
/// A monitor event containing an HTLCUpdate. /// A monitor event containing an HTLCUpdate.
HTLCEvent(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), HolderForceClosed(OutPoint),
/// Indicates a [`ChannelMonitor`] update has completed. See /// Indicates a [`ChannelMonitor`] update has completed. See