Skip to content

Commit d4c3e16

Browse files
committed
Fix outdated ChannelMonitor docs
ChannelMonitor::get_and_clear_pending_events docs references a method that had been refactored and is no longer accurate.
1 parent f1428fd commit d4c3e16

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

lightning/src/chain/channelmonitor.rs

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1305,9 +1305,11 @@ impl<Signer: Sign> ChannelMonitor<Signer> {
13051305
/// Gets the list of pending events which were generated by previous actions, clearing the list
13061306
/// in the process.
13071307
///
1308-
/// This is called by ChainMonitor::get_and_clear_pending_events() and is equivalent to
1309-
/// EventsProvider::get_and_clear_pending_events() except that it requires &mut self as we do
1310-
/// no internal locking in ChannelMonitors.
1308+
/// This is called by the [`EventsProvider::process_pending_events`] implementation for
1309+
/// [`ChainMonitor`].
1310+
///
1311+
/// [`EventsProvider::process_pending_events`]: crate::util::events::EventsProvider::process_pending_events
1312+
/// [`ChainMonitor`]: crate::chain::chainmonitor::ChainMonitor
13111313
pub fn get_and_clear_pending_events(&self) -> Vec<Event> {
13121314
self.inner.lock().unwrap().get_and_clear_pending_events()
13131315
}

0 commit comments

Comments
 (0)