From 50a9a687dd54587b43b185f2cd582df0b5460951 Mon Sep 17 00:00:00 2001 From: Aron Heinecke Date: Mon, 5 Sep 2022 01:14:06 +0200 Subject: [PATCH] debouncer: correctly document crossbeam feature --- CHANGELOG.md | 6 ++++++ notify-debouncer-mini/Cargo.toml | 2 +- notify-debouncer-mini/src/lib.rs | 7 ++++--- 3 files changed, 11 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 64297600..8e53963a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,12 @@ v4 commits split out to branch `v4_maintenance` starting with `4.0.16` +## debouncer-mini 0.2.1 (2022-09-05) + +- DOCS: correctly document the `crossbeam` feature [#440] + +[#440]: https://github.com/notify-rs/notify/pull/440 + ## debouncer-mini 0.2.0 (2022-08-30) Upgrade notify dependency to 5.0.0 diff --git a/notify-debouncer-mini/Cargo.toml b/notify-debouncer-mini/Cargo.toml index 47ffa657..270a6678 100644 --- 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 index a63bf9a8..ec027a82 100644 --- a/notify-debouncer-mini/src/lib.rs +++ b/notify-debouncer-mini/src/lib.rs @@ -42,10 +42,11 @@ //! //! # Features //! -//! The following feature can be turned on or off. +//! The following crate features can be turned on or off in your cargo dependency config: //! -//! - `crossbeam-channel` enabled by default, adds DebounceEventHandler support for crossbeam channels. -//! - `serde` enabled serde support for events. +//! - `crossbeam` enabled by default, adds [`DebounceEventHandler`](DebounceEventHandler) support for crossbeam channels. +//! Also enables crossbeam-channel in the re-exported notify. You may want to disable this when using the tokio async runtime. +//! - `serde` enables serde support for events. #[cfg(feature = "serde")] use serde::{Deserialize, Serialize}; use std::{