From b878d56833efca0b479f84addfaf937bcffb4418 Mon Sep 17 00:00:00 2001 From: pantonshire Date: Fri, 18 Aug 2023 09:31:20 +0100 Subject: [PATCH] mention Debouncer drop impl in documentation --- src/lib.rs | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/lib.rs b/src/lib.rs index 0e58337..dd7ec69 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -39,6 +39,8 @@ use std::{ /// # Ok(()) /// # } /// ``` +/// +/// When dropped, the debouncer will close the mpsc channel associated with it. pub struct Debouncer { thread: Option>, // This is reference counted because the debouncer thread needs access to the controller, and