f - Add documentation for stop and join panics

Author: jkczyz

lightning-background-processor/src/lib.rs

@@ -166,6 +166,11 @@ impl BackgroundProcessor {
 	/// Join `BackgroundProcessor`'s thread, returning any error that occurred while persisting
 	/// [`ChannelManager`].
 	///
+	/// # Panics
+	///
+	/// This function panics if the background thread has panicked such as while persisting or
+	/// handling events.
+	///
 	/// [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
 	pub fn join(mut self) -> Result<(), std::io::Error> {
 		assert!(self.thread_handle.is_some());
@@ -175,6 +180,11 @@ impl BackgroundProcessor {
 	/// Stop `BackgroundProcessor`'s thread, returning any error that occurred while persisting
 	/// [`ChannelManager`].
 	///
+	/// # Panics
+	///
+	/// This function panics if the background thread has panicked such as while persisting or
+	/// handling events.
+	///
 	/// [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
 	pub fn stop(mut self) -> Result<(), std::io::Error> {
 		assert!(self.thread_handle.is_some());