debouncer: correctly document crossbeam feature

notify-rs · Aug 31, 2022 · 4162b8d · 4162b8d
1 parent 36d1da5
commit 4162b8d
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/notify-debouncer-mini/Cargo.toml b/notify-debouncer-mini/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "notify-debouncer-mini"
-version = "0.2.0"
+version = "0.2.1"
 edition = "2021"
 rust-version = "1.56"
 description = "notify mini debouncer for events"

diff --git a/notify-debouncer-mini/src/lib.rs b/notify-debouncer-mini/src/lib.rs
@@ -44,7 +44,8 @@
 //!
 //! The following feature can be turned on or off.
 //!
-//! - `crossbeam-channel` enabled by default, adds DebounceEventHandler support for crossbeam channels.
+//! - `crossbeam` enabled by default, adds DebounceEventHandler support for crossbeam channels.
+//!   Also enables crossbeam-channel in the re-exported notify. You my want to disable this when using the tokio async runtime.
 //! - `serde` enabled serde support for events.
 #[cfg(feature = "serde")]
 use serde::{Deserialize, Serialize};