Fix outdated ChannelMonitor docs
authorJeffrey Czyz <jkczyz@gmail.com>
Wed, 9 Nov 2022 17:11:08 +0000 (11:11 -0600)
committerJeffrey Czyz <jkczyz@gmail.com>
Wed, 9 Nov 2022 17:19:00 +0000 (11:19 -0600)
ChannelMonitor::get_and_clear_pending_events docs references a method
that had been refactored and is no longer accurate.

lightning/src/chain/channelmonitor.rs

index d873a1df00c6f4535b497e6fe44a76ad34d9958e..0351a4ac501da92cb7257d672fa8c3f263e61df2 100644 (file)
@@ -1305,9 +1305,11 @@ impl<Signer: Sign> ChannelMonitor<Signer> {
        /// Gets the list of pending events which were generated by previous actions, clearing the list
        /// in the process.
        ///
-       /// This is called by ChainMonitor::get_and_clear_pending_events() and is equivalent to
-       /// EventsProvider::get_and_clear_pending_events() except that it requires &mut self as we do
-       /// no internal locking in ChannelMonitors.
+       /// This is called by the [`EventsProvider::process_pending_events`] implementation for
+       /// [`ChainMonitor`].
+       ///
+       /// [`EventsProvider::process_pending_events`]: crate::util::events::EventsProvider::process_pending_events
+       /// [`ChainMonitor`]: crate::chain::chainmonitor::ChainMonitor
        pub fn get_and_clear_pending_events(&self) -> Vec<Event> {
                self.inner.lock().unwrap().get_and_clear_pending_events()
        }