improve doc

Author: SpecificProtagonist

crates/bevy_app/src/main_schedule.rs

@@ -74,7 +74,8 @@ pub struct RunFixedUpdateLoop;
 #[derive(ScheduleLabel, Clone, Debug, PartialEq, Eq, Hash)]
 pub struct FixedUpdate;
 
-/// Indicates that [`RunFixedUpdateLoop`] is currently active.
+/// Indicates that fixed updates are currently running.
+/// This is automatically set by `bevy_time`.
 #[derive(Resource)]
 pub struct FixedUpdateScheduleIsCurrentlyRunning {
     /// Sequentially increasing with each fixed update.

crates/bevy_gizmos/src/lib.rs

@@ -15,10 +15,16 @@
 //! ```
 //!
 //! See the documentation on [`Gizmos`](crate::gizmos::Gizmos) for more examples.
+//!
+//! Gizmos will only be visible for the upcomming frame, or until the next fixed
+//! update if drawn during [`FixedUpdate`] as indicated by [`FixedUpdateScheduleIsCurrentlyRunning`].
+//!
+//! [`FixedUpdate`]: ::bevy_app::FixedUpdate
+//! [`FixedUpdateScheduleIsCurrentlyRunning`]: ::bevy_app::FixedUpdateScheduleIsCurrentlyRunning
 
 use std::mem;
 
-use bevy_app::{Last, Plugin, Update};
+use bevy_app::{FixedUpdate, Last, Plugin, Update};
 use bevy_asset::{load_internal_asset, AddAsset, Assets, Handle, HandleUntyped};
 use bevy_core::cast_slice;
 use bevy_ecs::{
@@ -90,12 +96,10 @@ impl Plugin for GizmoPlugin {
                     draw_aabbs,
                     draw_all_aabbs.run_if(|config: Res<GizmoConfig>| config.aabb.draw_all),
                 ),
-            );
-
-        // Ensure gizmos from previous fixed update are cleaned up if no other system
-        // accesses gizmos during fixed update any more
-        #[cfg(feature = "fixed_update")]
-        app.add_systems(bevy_app::FixedUpdate, |_: Gizmos| ());
+            )
+            // Ensure gizmos from previous fixed update are cleaned up if no other system
+            // accesses gizmos during fixed update any more
+            .add_systems(FixedUpdate, |_: Gizmos| ());
 
         let Ok(render_app) = app.get_sub_app_mut(RenderApp) else { return; };
 

crates/bevy_internal/src/lib.rs

@@ -189,6 +189,12 @@ pub mod gizmos {
     //! ```
     //!
     //! See the documentation on [`Gizmos`](gizmos::Gizmos) for more examples.
+    //!
+    //! Gizmos will only be visible for the upcomming frame, or until the next fixed
+    //! update if drawn during [`FixedUpdate`] as indicated by [`FixedUpdateScheduleIsCurrentlyRunning`].
+    //!
+    //! [`FixedUpdate`]: ::bevy_app::FixedUpdate
+    //! [`FixedUpdateScheduleIsCurrentlyRunning`]: ::bevy_app::FixedUpdateScheduleIsCurrentlyRunning
     pub use bevy_gizmos::*;
 }