From 17192310472778bf94566b027ac1be0abdd05a7c Mon Sep 17 00:00:00 2001
From: Matias Fontanini <matias.fontanini@gmail.com>
Date: Mon, 19 May 2025 17:49:01 -0700
Subject: [PATCH] feat: make `document-features` crate optional (#991)

---
 Cargo.toml | 13 ++++++++-----
 src/lib.rs |  5 +++--
 2 files changed, 11 insertions(+), 7 deletions(-)

diff --git a/Cargo.toml b/Cargo.toml
index 41c3797d..87141f86 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -21,7 +21,7 @@ path = "src/lib.rs"
 all-features = true
 
 [features]
-default = ["bracketed-paste", "events", "windows", "derive-more"]
+default = ["bracketed-paste", "derive-more", "events", "windows"]
 
 #! ### Default features
 ## Enables triggering [`Event::Paste`](event::Event::Paste) when pasting text into the terminal.
@@ -33,8 +33,14 @@ events = ["dep:mio", "dep:signal-hook", "dep:signal-hook-mio"]
 ## Enables windows specific crates.
 windows = ["dep:winapi", "dep:crossterm_winapi"]
 
+## Enables `is_*` helper functions for event enums.
+derive-more = ["dep:derive_more"]
+
 #! ### Optional Features
 
+## Enables documentation for crate features.
+document-features = ["dep:document-features"]
+
 ## Enables the [EventStream](event::EventStream) struct for async event reading.
 event-stream = ["dep:futures-core", "events"]
 
@@ -44,9 +50,6 @@ serde = ["dep:serde", "bitflags/serde"]
 ## Enables raw file descriptor polling / selecting instead of mio.
 use-dev-tty = ["filedescriptor", "rustix/process"]
 
-## Enables `is_*` helper functions for event enums.
-derive-more = ["dep:derive_more"]
-
 ## Enables interacting with a host clipboard via [`clipboard`](clipboard/index.html)
 osc52 = ["dep:base64"]
 
@@ -54,7 +57,7 @@ osc52 = ["dep:base64"]
 base64 = { version = "0.22", optional = true }
 bitflags = { version = "2.9" }
 derive_more = { version = "2.0.0", features = ["is_variant"], optional = true }
-document-features = "0.2.11"
+document-features = { version = "0.2.11", optional = true }
 futures-core = { version = "0.3", optional = true, default-features = false }
 parking_lot = "0.12"
 serde = { version = "1.0", features = ["derive"], optional = true }
diff --git a/src/lib.rs b/src/lib.rs
index 96818291..fdb9c503 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -226,8 +226,9 @@
 //!   Ok(())
 //! }
 //!```
-//! ## Feature Flags
-#![doc = document_features::document_features!()]
+//!
+#![cfg_attr(feature = "document-features", doc = "## Feature Flags")]
+#![cfg_attr(feature = "document-features", doc = document_features::document_features!())]
 //!
 //! [write]: https://doc.rust-lang.org/std/io/trait.Write.html
 //! [stdout]: https://doc.rust-lang.org/std/io/fn.stdout.html