f - Clarify docs about PeerManager::process_events

Author: jkczyz

lightning-background-processor/src/lib.rs

@@ -29,14 +29,16 @@ use std::ops::Deref;
 /// `BackgroundProcessor` takes care of tasks that (1) need to happen periodically to keep
 /// Rust-Lightning running properly, and (2) either can or should be run in the background. Its
 /// responsibilities are:
-/// * Processing [`MessageSendEvent`]s by calling [`PeerManager::process_events`].
 /// * Processing [`Event`]s with a user-provided [`EventHandler`].
 /// * Monitoring whether the [`ChannelManager`] needs to be re-persisted to disk, and if so,
 ///   writing it to disk/backups by invoking the callback given to it at startup.
 ///   [`ChannelManager`] persistence should be done in the background.
 /// * Calling [`ChannelManager::timer_tick_occurred`] and [`PeerManager::timer_tick_occurred`]
 ///   at the appropriate intervals.
 ///
+/// It will also call [`PeerManager::process_events`] periodically though this shouldn't be relied
+/// upon as doing so may result in high latency.
+///
 /// # Note
 ///
 /// If [`ChannelManager`] persistence fails and the persisted manager becomes out-of-date, then
@@ -46,7 +48,6 @@ use std::ops::Deref;
 ///
 /// [`ChannelMonitor`]: lightning::chain::channelmonitor::ChannelMonitor
 /// [`Event`]: lightning::util::events::Event
-/// [`MessageSendEvent`]: lightning::util::events::MessageSendEvent
 #[must_use = "BackgroundProcessor will immediately stop on drop. It should be stored until shutdown."]
 pub struct BackgroundProcessor {
 	stop_thread: Arc<AtomicBool>,