Enable document-features by default in eframe and egui-wgpu

emilk · Feb 5, 2024 · 9d2d9b5 · 9d2d9b5
1 parent 20131cb
commit 9d2d9b5
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 9 deletions.
diff --git a/crates/eframe/Cargo.toml b/crates/eframe/Cargo.toml
@@ -105,7 +105,7 @@ web_screen_reader = [
 ## By default, only WebGPU is enabled on web.
 ## If you want to enable WebGL, you need to turn on the `webgl` feature of crate `wgpu`:
 ##
-## ```ignore
+## ```toml
 ## wgpu = { version = "*", features = ["webgpu", "webgl"] }
 ## ```
 ##
@@ -125,16 +125,16 @@ egui = { version = "0.25.0", path = "../egui", default-features = false, feature
   "bytemuck",
   "log",
 ] }
+
+document-features.workspace = true
 log = { version = "0.4", features = ["std"] }
 parking_lot = "0.12"
 raw-window-handle.workspace = true
 static_assertions = "1.1.0"
 thiserror.workspace = true
 web-time.workspace = true
 
-#! ### Optional dependencies
-## Enable this when generating docs.
-document-features = { workspace = true, optional = true }
+# Optional dependencies
 
 egui_glow = { version = "0.25.0", path = "../egui_glow", optional = true, default-features = false }
 glow = { workspace = true, optional = true }

diff --git a/crates/eframe/src/lib.rs b/crates/eframe/src/lib.rs
@@ -130,7 +130,7 @@
 //! ```
 //!
 //! ## Feature flags
-#![cfg_attr(feature = "document-features", doc = document_features::document_features!())]
+#![doc = document_features::document_features!()]
 //!
 
 #![warn(missing_docs)] // let's keep eframe well-documented

diff --git a/crates/egui-wgpu/Cargo.toml b/crates/egui-wgpu/Cargo.toml
@@ -48,15 +48,14 @@ epaint = { version = "0.25.0", path = "../epaint", default-features = false, fea
 ] }
 
 bytemuck = "1.7"
+document-features.workspace = true
 log = { version = "0.4", features = ["std"] }
 thiserror.workspace = true
 type-map = "0.5.0"
 web-time.workspace = true
 wgpu = { workspace = true, features = ["wgsl"] }
 
-#! ### Optional dependencies
-## Enable this when generating docs.
-document-features = { workspace = true, optional = true }
+# Optional dependencies:
 
 winit = { workspace = true, optional = true, default-features = false, features = [
   "rwh_06",

diff --git a/crates/egui-wgpu/src/lib.rs b/crates/egui-wgpu/src/lib.rs
@@ -13,7 +13,7 @@
 //! The default is to prefer WebGPU and fall back on WebGL.
 //!
 //! ## Feature flags
-#![cfg_attr(feature = "document-features", doc = document_features::document_features!())]
+#![doc = document_features::document_features!()]
 //!
 
 #![allow(unsafe_code)]