From 7ed695f3a2b42cd4cec48aeba0b303eedd102869 Mon Sep 17 00:00:00 2001 From: Mike Date: Wed, 4 Jan 2023 12:14:34 -0800 Subject: [PATCH] clean up docs Co-authored-by: JoJoJet <21144246+JoJoJet@users.noreply.github.com> --- crates/bevy_app/src/app.rs | 4 ++-- crates/bevy_ecs/src/schedule/mod.rs | 2 +- crates/bevy_render/src/lib.rs | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/crates/bevy_app/src/app.rs b/crates/bevy_app/src/app.rs index 99dc0762842ad..11d37d8cbe23e 100644 --- a/crates/bevy_app/src/app.rs +++ b/crates/bevy_app/src/app.rs @@ -94,13 +94,13 @@ struct SubApp { } impl SubApp { - /// run the `SubApp`'s schedule + /// Runs the `SubApp`'s schedule. pub fn run(&mut self) { self.app.schedule.run(&mut self.app.world); self.app.world.clear_trackers(); } - /// extract data from main world to sub app + /// Extracts data from main world to this sub-app. pub fn extract(&mut self, main_world: &mut World) { (self.extract)(main_world, &mut self.app); } diff --git a/crates/bevy_ecs/src/schedule/mod.rs b/crates/bevy_ecs/src/schedule/mod.rs index 1a00453ef9f98..d5c2e91342e98 100644 --- a/crates/bevy_ecs/src/schedule/mod.rs +++ b/crates/bevy_ecs/src/schedule/mod.rs @@ -361,7 +361,7 @@ impl Schedule { .and_then(|stage| stage.downcast_mut::()) } - /// Remove a [`Stage`] from the schedule + /// Removes a [`Stage`] from the schedule. pub fn remove_stage(&mut self, stage_label: impl StageLabel) -> Option> { let label = stage_label.as_label(); diff --git a/crates/bevy_render/src/lib.rs b/crates/bevy_render/src/lib.rs index c74ab11915447..0ba66415c35c8 100644 --- a/crates/bevy_render/src/lib.rs +++ b/crates/bevy_render/src/lib.rs @@ -92,7 +92,7 @@ pub enum RenderStage { Cleanup, } -/// Resource for holding the extract stage of the rendering schedule +/// Resource for holding the extract stage of the rendering schedule. #[derive(Resource)] pub struct ExtractStage(pub SystemStage);