Add internal docs for ChannelMonitor::payment_preimages

[rust-lightning] / lightning / src / ln / channel.rs

diff --git a/lightning/src/ln/channel.rs b/lightning/src/ln/channel.rs
index 1d204d18a17ed620b24a228d66856175137ceb5a..cde1e8a13bd0d678ef0d54da0fcf4458f2b482ae 100644 (file)
--- a/lightning/src/ln/channel.rs
+++ b/lightning/src/ln/channel.rs
@@ -1703,11 +1703,11 @@ impl<Signer: Sign> Channel<Signer> {
                make_funding_redeemscript(&self.get_holder_pubkeys().funding_pubkey, self.counterparty_funding_pubkey())
        }
 
-       /// Claims an HTLC while we're disconnected from a peer, dropping the ChannelMonitorUpdate
+       /// Claims an HTLC while we're disconnected from a peer, dropping the [`ChannelMonitorUpdate`]
        /// entirely.
        ///
-       /// The ChannelMonitor for this channel MUST be updated out-of-band with the preimage provided
-       /// (i.e. without calling [`crate::chain::Watch::update_channel`]).
+       /// The [`ChannelMonitor`] for this channel MUST be updated out-of-band with the preimage
+       /// provided (i.e. without calling [`crate::chain::Watch::update_channel`]).
        ///
        /// The HTLC claim will end up in the holding cell (because the caller must ensure the peer is
        /// disconnected).