diff --git a/crates/bevy_dev_tools/src/lib.rs b/crates/bevy_dev_tools/src/lib.rs index e424f2a1101e64..7fcfd7379d72be 100644 --- a/crates/bevy_dev_tools/src/lib.rs +++ b/crates/bevy_dev_tools/src/lib.rs @@ -7,6 +7,23 @@ use bevy_app::prelude::*; pub mod ci_testing; /// Enables developer tools in an [`App`]. +/// This plugin is part of the [`DefaultPlugins`](https://docs.rs/bevy/latest/bevy/struct.DefaultPlugins.html), and enabled by default. +/// +/// It's recommended to disable it in a release. To disable it, you can either: +/// +/// - Remove it when adding [`DefaultPlugins`](https://docs.rs/bevy/latest/bevy/struct.DefaultPlugins.html): +/// ```no_run +/// # use bevy_app::{App, NoopPluginGroup as DefaultPlugins, PluginGroup}; +/// # use bevy_dev_tools::{DevToolsPlugin}; +/// fn main() { +/// App::new() +/// .add_plugins(DefaultPlugins.build().disable::()) +/// .run(); +/// } +/// ``` +/// +/// - Disable the feature: +/// Disable default features from Bevy, and don't enable the feature `bevy_dev_tools`. pub struct DevToolsPlugin; impl Plugin for DevToolsPlugin {