Add update_persisted_channel doc to indicate rare case for None update
authorGursharan Singh <3442979+G8XSU@users.noreply.github.com>
Fri, 29 Sep 2023 20:41:18 +0000 (13:41 -0700)
committerGursharan Singh <3442979+G8XSU@users.noreply.github.com>
Fri, 29 Sep 2023 23:26:40 +0000 (16:26 -0700)
lightning/src/chain/chainmonitor.rs

index 086a848af77aa05c7ea4e8e97e93c4e6fb5e9628..d70ebd40d667ad840c012197484d4f94d1f2ced4 100644 (file)
@@ -164,8 +164,8 @@ pub trait Persist<ChannelSigner: WriteableEcdsaChannelSigner> {
        /// updated monitor itself to disk/backups. See the [`Persist`] trait documentation for more
        /// details.
        ///
-       /// During blockchain synchronization operations, this may be called with no
-       /// [`ChannelMonitorUpdate`], in which case the full [`ChannelMonitor`] needs to be persisted.
+       /// During blockchain synchronization operations, and in some rare cases, this may be called with
+       /// no [`ChannelMonitorUpdate`], in which case the full [`ChannelMonitor`] needs to be persisted.
        /// Note that after the full [`ChannelMonitor`] is persisted any previous
        /// [`ChannelMonitorUpdate`]s which were persisted should be discarded - they can no longer be
        /// applied to the persisted [`ChannelMonitor`] as they were already applied.