f - Mention NetworkUpdateHandler in BackgroundProcessor docs

lightningdevkit · Aug 19, 2021 · 4e2f2a4 · 4e2f2a4
1 parent 788e591
commit 4e2f2a4
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/lightning-background-processor/src/lib.rs b/lightning-background-processor/src/lib.rs
@@ -114,7 +114,8 @@ impl BackgroundProcessor {
 	/// # Event Handling
 	///
 	/// `event_handler` is responsible for handling events that users should be notified of (e.g.,
-	/// payment failed). See [`EventHandler`] for details.
+	/// payment failed). See [`EventHandler`] for details. As a convenience, `BackgroundProcessor`
+	/// decorates the user-provided event handler with [`NetworkUpdateHandler`].
 	///
 	/// [top-level documentation]: Self
 	/// [`join`]: Self::join