]> git.bitcoin.ninja Git - rust-lightning/commitdiff
Minor doc tweaks to `MonitorHolder` 2024-08-old-doc-tweaks
authorMatt Corallo <git@bluematt.me>
Wed, 7 Aug 2024 14:31:01 +0000 (14:31 +0000)
committerMatt Corallo <git@bluematt.me>
Wed, 7 Aug 2024 14:31:01 +0000 (14:31 +0000)
036c31c9d0b6a243fa33aa5f8d5148d2ca065617 introduced some minor doc
changes but failed to imrpove the docs that is was changing fully
which this does. Suggested by @tnull in review.

lightning/src/chain/chainmonitor.rs

index 57c673239f7afcc326b2dde0d131df730a184ccb..7e342f58783af28611fc047c8b4fcd3779d1b03f 100644 (file)
@@ -170,14 +170,15 @@ struct MonitorHolder<ChannelSigner: EcdsaChannelSigner> {
        /// Note that this lock must be held from [`ChannelMonitor::update_monitor`] through to
        /// [`Persist::update_persisted_channel`] to prevent a race where we call
        /// [`Persist::update_persisted_channel`], the user returns a
-       /// [`ChannelMonitorUpdateStatus::InProgress`], and then calls channel_monitor_updated
-       /// immediately, racing our insertion of the pending update into the contained Vec.
+       /// [`ChannelMonitorUpdateStatus::InProgress`], and then calls
+       /// [`ChainMonitor::channel_monitor_updated`] immediately, racing our insertion of the pending
+       /// update into the contained Vec.
        ///
        /// This also avoids a race where we update a [`ChannelMonitor`], then while connecting a block
        /// persist a full [`ChannelMonitor`] prior to persisting the [`ChannelMonitorUpdate`]. This
        /// could cause users to have a full [`ChannelMonitor`] on disk as well as a
        /// [`ChannelMonitorUpdate`] which was already applied. While this isn't an issue for the
-       /// LDK-provided update-based [`Persist`], its somewhat surprising for users so we avoid it.
+       /// LDK-provided update-based [`Persist`], it is somewhat surprising for users so we avoid it.
        pending_monitor_updates: Mutex<Vec<u64>>,
 }