From: Jeffrey Czyz <jkczyz@gmail.com>
Date: Wed, 9 Nov 2022 17:11:08 +0000 (-0600)
Subject: Fix outdated ChannelMonitor docs
X-Git-Tag: v0.0.113~49^2
X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=commitdiff_plain;h=d4c3e16556bcbd2cc8998a18d422e2b4d86ffdbb;p=rust-lightning

Fix outdated ChannelMonitor docs

ChannelMonitor::get_and_clear_pending_events docs references a method
that had been refactored and is no longer accurate.
---

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<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()
 	}