From d4c3e16556bcbd2cc8998a18d422e2b4d86ffdbb Mon Sep 17 00:00:00 2001 From: Jeffrey Czyz Date: Wed, 9 Nov 2022 11:11:08 -0600 Subject: [PATCH] Fix outdated ChannelMonitor docs ChannelMonitor::get_and_clear_pending_events docs references a method that had been refactored and is no longer accurate. --- lightning/src/chain/channelmonitor.rs | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/lightning/src/chain/channelmonitor.rs b/lightning/src/chain/channelmonitor.rs index d873a1df0..0351a4ac5 100644 --- a/lightning/src/chain/channelmonitor.rs +++ b/lightning/src/chain/channelmonitor.rs @@ -1305,9 +1305,11 @@ impl ChannelMonitor { /// 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 { self.inner.lock().unwrap().get_and_clear_pending_events() } -- 2.39.5