f - Mention BackgroundProcessor in NetworkUpdateHandler docs

lightningdevkit · Aug 19, 2021 · 788e591 · 788e591
1 parent 971e668
commit 788e591
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/lightning/src/routing/network_graph.rs b/lightning/src/routing/network_graph.rs
@@ -139,7 +139,13 @@ impl_writeable_tlv_based_enum_upgradable!(NetworkUpdate,
 /// Once `event_handler` has been decorated, use it with any implementation of [`EventsProvider`] as
 /// usual.
 ///
+/// # Note
+///
+/// [`BackgroundProcessor`] is configured to decorate the user-provided [`EventHandler`] with this
+/// handler.
+///
 /// [`EventsProvider`]: crate::util::events::EventsProvider
+/// [`BackgroundProcessor`]: ../../../lightning_background_processor/struct.BackgroundProcessor.html
 pub struct NetworkUpdateHandler<G: Deref<Target=NetworkGraph>, L: Deref, E: EventHandler>
 where L::Target: Logger {
 	secp_ctx: Secp256k1<secp256k1::VerifyOnly>,