From a2db34053522af962fb2687a26ffeaf450915740 Mon Sep 17 00:00:00 2001 From: Mike Hsu Date: Fri, 22 Sep 2023 16:58:09 -0700 Subject: [PATCH] reword docs --- crates/bevy_ecs/src/schedule/schedule.rs | 10 ++++++---- crates/bevy_ecs/src/world/mod.rs | 4 ++-- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/crates/bevy_ecs/src/schedule/schedule.rs b/crates/bevy_ecs/src/schedule/schedule.rs index c285c794b806e..752a3ec20388a 100644 --- a/crates/bevy_ecs/src/schedule/schedule.rs +++ b/crates/bevy_ecs/src/schedule/schedule.rs @@ -1733,17 +1733,17 @@ impl ScheduleBuildSettings { } } -/// list of [`ComponentId`]'s to ignore when reporting ambiguity conflicts between systems +/// List of [`ComponentId`]s to ignore when reporting system order ambiguity conflicts #[derive(Resource, Default, Clone, Debug)] pub struct IgnoredSchedulingAmbiguities(BTreeSet); impl IgnoredSchedulingAmbiguities { - /// Ignore ambiguities between systems in [`Component`] T. + /// Ignore system order ambiguities caused by conflicts on [`Component`]s of type `T`. pub fn allow_ambiguous_component(&mut self, world: &mut World) { self.0.insert(world.init_component::()); } - /// Ignore ambiguities between systems in [`Resource`] T. + /// Ignore system order ambiguities caused by conflicts on [`Resource`]s of type `T`. pub fn allow_ambiguous_resource(&mut self, world: &mut World) { self.0.insert(world.components.init_resource::()); } @@ -1758,7 +1758,9 @@ impl IgnoredSchedulingAmbiguities { /// May panic or retrieve incorrect names if [`Components`] is not from the same /// world pub fn print_names(&self, components: &Components) { - let mut message = "Ambiguities of the following types are ignored:\n".to_string(); + let mut message = + "System order ambiguities caused by conflicts on the following types are ignored:\n" + .to_string(); for id in self.iter() { writeln!(message, "{}", components.get_name(*id).unwrap()).unwrap(); } diff --git a/crates/bevy_ecs/src/world/mod.rs b/crates/bevy_ecs/src/world/mod.rs index fa970f237a269..819981845c626 100644 --- a/crates/bevy_ecs/src/world/mod.rs +++ b/crates/bevy_ecs/src/world/mod.rs @@ -2088,7 +2088,7 @@ impl World { self.schedule_scope(label, |world, sched| sched.run(world)); } - /// Ignore ambiguities between systems in [`Component`] T. + /// Ignore system order ambiguities caused by conflicts on [`Component`]s of type `T`. pub fn allow_ambiguous_component(&mut self) { let mut ignored_ambiguities = self .remove_resource::() @@ -2097,7 +2097,7 @@ impl World { self.insert_resource(ignored_ambiguities); } - /// Ignore ambiguities between systems in [`Resource`] T. + /// Ignore system order ambiguities caused by conflicts on [`Resource`]s of type `T`. pub fn allow_ambiguous_resource(&mut self) { let mut ignored_ambiguities = self .remove_resource::()