From c475a2a954005fdfdecd39f87ca1009a423393eb Mon Sep 17 00:00:00 2001 From: lelo <15314665+hate@users.noreply.github.com> Date: Mon, 22 May 2023 22:16:56 -0400 Subject: [PATCH] Correct RequestRedraw documentation (#8640) # Objective - Since the `RequestRedraw` event triggers the bevy app to run `update` in `bevy_app::app::App`, the documentation should state that all the windows in the application and its sub-apps are going to get redrawn, rather than a single window. ## Solution - Change `RequestRedraw` documentation in `bevy_window` to mention every window. --- crates/bevy_window/src/event.rs | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/crates/bevy_window/src/event.rs b/crates/bevy_window/src/event.rs index 0f240edbd5..59b30bf396 100644 --- a/crates/bevy_window/src/event.rs +++ b/crates/bevy_window/src/event.rs @@ -24,9 +24,8 @@ pub struct WindowResized { pub height: f32, } -// TODO: This would redraw all windows ? If yes, update docs to reflect this -/// An event that indicates the window should redraw, even if its control flow is set to `Wait` and -/// there have been no window events. +/// An event that indicates all of the application's windows should be redrawn, +/// even if their control flow is set to `Wait` and there have been no window events. #[derive(Debug, Clone, PartialEq, Eq, Reflect, FromReflect)] #[reflect(Debug, PartialEq)] #[cfg_attr(