diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d824700af7..c360d723a8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -103,7 +103,7 @@ Some things that are reason to apply the [`S-Controversial`] label to a PR: Some things that are reason to apply the [`D-Complex`] label to a PR: -1. Introduction or modification of soundness relevent code (for example `unsafe` code) +1. Introduction or modification of soundness relevant code (for example `unsafe` code) 2. High levels of technical complexity. 3. Large-scale code reorganization @@ -324,7 +324,7 @@ If you're new to Bevy, here's the workflow we use: * `cargo run -p ci -- test` - to run tests * `cargo run -p ci -- doc` - to run doc tests and doc checks * `cargo run -p ci -- compile` - to check that everything that must compile still does (examples and benches), and that some that shouldn't still don't ([`crates/bevy_ecs_compile_fail_tests`](./crates/bevy_ecs_compile_fail_tests)) - * to get more informations on commands available and what is run, check the [tools/ci crate](./tools/ci) + * to get more information on commands available and what is run, check the [tools/ci crate](./tools/ci) 4. When working with Markdown (`.md`) files, Bevy's CI will check markdown files (like this one) using [markdownlint](https://github.com/DavidAnson/markdownlint). To locally lint your files using the same workflow as our CI: diff --git a/crates/bevy_animation/src/lib.rs b/crates/bevy_animation/src/lib.rs index da8527b8b2..3ba89d0a62 100644 --- a/crates/bevy_animation/src/lib.rs +++ b/crates/bevy_animation/src/lib.rs @@ -468,7 +468,7 @@ fn apply_animation( // any of their descendant Transforms. // // The system scheduler prevents any other system from mutating Transforms at the same time, - // so the only way this fetch can alias is if two AnimationPlayers are targetting the same bone. + // so the only way this fetch can alias is if two AnimationPlayers are targeting the same bone. // This can only happen if there are two or more AnimationPlayers are ancestors to the same // entities. By verifying that there is no other AnimationPlayer in the ancestors of a // running AnimationPlayer before animating any entity, this fetch cannot alias. diff --git a/crates/bevy_ecs/src/archetype.rs b/crates/bevy_ecs/src/archetype.rs index a25551f013..777dd0d2e3 100644 --- a/crates/bevy_ecs/src/archetype.rs +++ b/crates/bevy_ecs/src/archetype.rs @@ -64,7 +64,7 @@ impl ArchetypeRow { /// Archetype IDs are only valid for a given World, and are not globally unique. /// Attempting to use an archetype ID on a world that it wasn't sourced from will /// not return the archetype with the same components. The only exception to this is -/// [`EMPTY`] which is guarenteed to be identical for all Worlds. +/// [`EMPTY`] which is guaranteed to be identical for all Worlds. /// /// [`World`]: crate::world::World /// [`EMPTY`]: crate::archetype::ArchetypeId::EMPTY diff --git a/crates/bevy_ecs/src/lib.rs b/crates/bevy_ecs/src/lib.rs index 103fd5106f..a85474f7d0 100644 --- a/crates/bevy_ecs/src/lib.rs +++ b/crates/bevy_ecs/src/lib.rs @@ -1536,7 +1536,7 @@ mod tests { assert_eq!(4, query_min_size![&A, ()], "Simple Archetypal"); assert_eq!(4, query_min_size![ChangeTrackers, ()],); // All the following should set minimum size to 0, as it's impossible to predict - // how many entites the filters will trim. + // how many entities the filters will trim. assert_eq!(0, query_min_size![(), Added], "Simple Added"); assert_eq!(0, query_min_size![(), Changed], "Simple Changed"); assert_eq!(0, query_min_size![(&A, &B), Changed],); @@ -1616,7 +1616,7 @@ mod tests { assert_eq!( world_b.get::(high_non_existent_entity), Some(&B(10)), - "inserting into newly allocated high / non-continous entity id works" + "inserting into newly allocated high / non-continuous entity id works" ); let high_non_existent_but_reserved_entity = Entity::new(5, 0); diff --git a/crates/bevy_ecs/src/schedule/stage.rs b/crates/bevy_ecs/src/schedule/stage.rs index 05846c630b..6efa2feeb7 100644 --- a/crates/bevy_ecs/src/schedule/stage.rs +++ b/crates/bevy_ecs/src/schedule/stage.rs @@ -1537,7 +1537,7 @@ mod tests { #[derive(Component)] struct Foo; - fn even_number_of_entities_critiera(query: Query<&Foo>) -> ShouldRun { + fn even_number_of_entities_criteria(query: Query<&Foo>) -> ShouldRun { if query.iter().len() % 2 == 0 { ShouldRun::Yes } else { @@ -1562,7 +1562,7 @@ mod tests { .with_system(spawn_entity.label(Spawn)) .with_system_set( SystemSet::new() - .with_run_criteria(even_number_of_entities_critiera) + .with_run_criteria(even_number_of_entities_criteria) .with_system(count_entities.before(Spawn)), ); stage.run(&mut world); @@ -1579,7 +1579,7 @@ mod tests { #[derive(Component)] struct Foo; - fn even_number_of_entities_critiera(query: Query<&Foo>) -> ShouldRun { + fn even_number_of_entities_criteria(query: Query<&Foo>) -> ShouldRun { if query.iter().len() % 2 == 0 { ShouldRun::Yes } else { @@ -1599,7 +1599,7 @@ mod tests { world.init_resource::(); let mut stage_spawn = SystemStage::parallel().with_system(spawn_entity); let mut stage_count = SystemStage::parallel() - .with_run_criteria(even_number_of_entities_critiera) + .with_run_criteria(even_number_of_entities_criteria) .with_system(count_entities); stage_count.run(&mut world); stage_spawn.run(&mut world); diff --git a/crates/bevy_ecs/src/schedule_v3/schedule.rs b/crates/bevy_ecs/src/schedule_v3/schedule.rs index 0fd860a7a9..360ca5249e 100644 --- a/crates/bevy_ecs/src/schedule_v3/schedule.rs +++ b/crates/bevy_ecs/src/schedule_v3/schedule.rs @@ -519,8 +519,8 @@ impl ScheduleGraph { match ambiguous_with { Ambiguity::Check => (), - Ambiguity::IgnoreWithSet(ambigous_with) => { - for set in ambigous_with + Ambiguity::IgnoreWithSet(ambiguous_with) => { + for set in ambiguous_with .into_iter() .map(|set| self.system_set_ids[&set]) { diff --git a/crates/bevy_ecs/src/system/commands/command_queue.rs b/crates/bevy_ecs/src/system/commands/command_queue.rs index 1a40b5ab67..d1cbc7f728 100644 --- a/crates/bevy_ecs/src/system/commands/command_queue.rs +++ b/crates/bevy_ecs/src/system/commands/command_queue.rs @@ -102,7 +102,7 @@ impl CommandQueue { // so this addition will not overflow its original allocation. let cmd = unsafe { self.bytes.as_mut_ptr().add(meta.offset) }; // SAFETY: It is safe to transfer ownership out of `self.bytes`, since the call to `set_len(0)` above - // gaurantees that nothing stored in the buffer will get observed after this function ends. + // guarantees that nothing stored in the buffer will get observed after this function ends. // `cmd` points to a valid address of a stored command, so it must be non-null. let cmd = unsafe { OwningPtr::new(NonNull::new_unchecked(cmd.cast())) }; // SAFETY: The underlying type of `cmd` matches the type expected by `meta.apply_command`. diff --git a/crates/bevy_input/src/keyboard.rs b/crates/bevy_input/src/keyboard.rs index 83b35fe47e..a792bc0f4b 100644 --- a/crates/bevy_input/src/keyboard.rs +++ b/crates/bevy_input/src/keyboard.rs @@ -281,7 +281,7 @@ pub enum KeyCode { Apostrophe, /// The `Apps` key. Apps, - /// The `Asterik` / `*` key. + /// The `Asterisk` / `*` key. Asterisk, /// The `Plus` / `+` key. Plus, diff --git a/crates/bevy_pbr/src/light.rs b/crates/bevy_pbr/src/light.rs index 407d048963..d1d9f13481 100644 --- a/crates/bevy_pbr/src/light.rs +++ b/crates/bevy_pbr/src/light.rs @@ -88,7 +88,7 @@ impl Default for PointLightShadowMap { } /// A light that emits light in a given direction from a central point. -/// Behaves like a point light in a perfectly absorbant housing that +/// Behaves like a point light in a perfectly absorbent housing that /// shines light only in a given direction. The direction is taken from /// the transform, and can be specified with [`Transform::looking_at`](bevy_transform::components::Transform::looking_at). #[derive(Component, Debug, Clone, Copy, Reflect)] diff --git a/crates/bevy_pbr/src/pbr_material.rs b/crates/bevy_pbr/src/pbr_material.rs index 2e65e3e835..9e95a3ffab 100644 --- a/crates/bevy_pbr/src/pbr_material.rs +++ b/crates/bevy_pbr/src/pbr_material.rs @@ -190,7 +190,7 @@ pub struct StandardMaterial { /// When a triangle is in a viewport, /// if its vertices appear counter-clockwise from the viewport's perspective, /// then the viewport is seeing the triangle's front face. - /// Conversly, if the vertices appear clockwise, you are seeing the back face. + /// Conversely, if the vertices appear clockwise, you are seeing the back face. /// /// In short, in bevy, front faces winds counter-clockwise. /// diff --git a/crates/bevy_pbr/src/render/shadows.wgsl b/crates/bevy_pbr/src/render/shadows.wgsl index ff81d0ea74..a3f1f79a97 100644 --- a/crates/bevy_pbr/src/render/shadows.wgsl +++ b/crates/bevy_pbr/src/render/shadows.wgsl @@ -75,7 +75,7 @@ fn fetch_spot_shadow(light_id: u32, frag_position: vec4, surface_normal: ve let light_inv_rot = mat3x3(right_dir, up_dir, fwd); // because the matrix is a pure rotation matrix, the inverse is just the transpose, and to calculate - // the product of the transpose with a vector we can just post-multiply instead of pre-multplying. + // the product of the transpose with a vector we can just post-multiply instead of pre-multiplying. // this allows us to keep the matrix construction code identical between CPU and GPU. let projected_position = offset_position * light_inv_rot; diff --git a/crates/bevy_ptr/src/lib.rs b/crates/bevy_ptr/src/lib.rs index f80cf2f519..e992cec575 100644 --- a/crates/bevy_ptr/src/lib.rs +++ b/crates/bevy_ptr/src/lib.rs @@ -461,13 +461,13 @@ impl DebugEnsureAligned for *mut T { #[track_caller] fn debug_ensure_aligned(self) -> Self { let align = core::mem::align_of::(); - // Implemenation shamelessly borrowed from the currently unstable + // Implementation shamelessly borrowed from the currently unstable // ptr.is_aligned_to. // // Replace once https://github.com/rust-lang/rust/issues/96284 is stable. assert!( self as usize & (align - 1) == 0, - "pointer is not aligned. Address {:p} does not have alignemnt {} for type {}", + "pointer is not aligned. Address {:p} does not have alignment {} for type {}", self, align, core::any::type_name::(), diff --git a/crates/bevy_reflect/bevy_reflect_derive/src/derive_data.rs b/crates/bevy_reflect/bevy_reflect_derive/src/derive_data.rs index 92b2035e19..79595b9881 100644 --- a/crates/bevy_reflect/bevy_reflect_derive/src/derive_data.rs +++ b/crates/bevy_reflect/bevy_reflect_derive/src/derive_data.rs @@ -349,7 +349,7 @@ impl<'a> ReflectStruct<'a> { /// Returns the `GetTypeRegistration` impl as a `TokenStream`. /// - /// Returns a specific implementation for structs and this method should be preffered over the generic [`get_type_registration`](crate::ReflectMeta) method + /// Returns a specific implementation for structs and this method should be preferred over the generic [`get_type_registration`](crate::ReflectMeta) method pub fn get_type_registration(&self) -> proc_macro2::TokenStream { let reflect_path = self.meta.bevy_reflect_path(); diff --git a/crates/bevy_reflect/bevy_reflect_derive/src/enum_utility.rs b/crates/bevy_reflect/bevy_reflect_derive/src/enum_utility.rs index b8b94c6933..a1a8fc8eb7 100644 --- a/crates/bevy_reflect/bevy_reflect_derive/src/enum_utility.rs +++ b/crates/bevy_reflect/bevy_reflect_derive/src/enum_utility.rs @@ -37,8 +37,8 @@ pub(crate) fn get_variant_constructors( } }; let mut reflect_index: usize = 0; - let constructor_fields = fields.iter().enumerate().map(|(declar_index, field)| { - let field_ident = ident_or_index(field.data.ident.as_ref(), declar_index); + let constructor_fields = fields.iter().enumerate().map(|(declare_index, field)| { + let field_ident = ident_or_index(field.data.ident.as_ref(), declare_index); let field_value = if field.attrs.ignore.is_ignored() { quote! { #FQDefault::default() } } else { diff --git a/crates/bevy_reflect/bevy_reflect_derive/src/impls/enums.rs b/crates/bevy_reflect/bevy_reflect_derive/src/impls/enums.rs index ce163092fa..a439e8b468 100644 --- a/crates/bevy_reflect/bevy_reflect_derive/src/impls/enums.rs +++ b/crates/bevy_reflect/bevy_reflect_derive/src/impls/enums.rs @@ -379,9 +379,9 @@ fn generate_impls(reflect_enum: &ReflectEnum, ref_index: &Ident, ref_name: &Iden } EnumVariantFields::Unnamed(fields) => { let args = get_field_args(fields, |reflect_idx, declaration_index, field| { - let declar_field = syn::Index::from(declaration_index); + let declare_field = syn::Index::from(declaration_index); enum_field_at.push(quote! { - #unit { #declar_field : value, .. } if #ref_index == #reflect_idx => #FQOption::Some(value) + #unit { #declare_field : value, .. } if #ref_index == #reflect_idx => #FQOption::Some(value) }); #[cfg(feature = "documentation")] diff --git a/crates/bevy_render/macros/src/as_bind_group.rs b/crates/bevy_render/macros/src/as_bind_group.rs index ee8a048758..8af04edd68 100644 --- a/crates/bevy_render/macros/src/as_bind_group.rs +++ b/crates/bevy_render/macros/src/as_bind_group.rs @@ -30,7 +30,7 @@ enum BindingState<'a> { ident: &'a Ident, }, OccupiedConvertedUniform, - OccupiedMergableUniform { + OccupiedMergeableUniform { uniform_fields: Vec<&'a syn::Field>, }, } @@ -144,7 +144,7 @@ pub fn derive_as_bind_group(ast: syn::DeriveInput) -> Result { match &mut binding_states[binding_index as usize] { value @ BindingState::Free => { *value = match binding_type { - BindingType::Uniform => BindingState::OccupiedMergableUniform { + BindingType::Uniform => BindingState::OccupiedMergeableUniform { uniform_fields: vec![field], }, _ => { @@ -179,7 +179,7 @@ pub fn derive_as_bind_group(ast: syn::DeriveInput) -> Result { format!("The '{field_name}' field cannot be assigned to binding {binding_index} because it is already occupied by a struct-level uniform binding at the same index.") )); } - BindingState::OccupiedMergableUniform { uniform_fields } => match binding_type { + BindingState::OccupiedMergeableUniform { uniform_fields } => match binding_type { BindingType::Uniform => { uniform_fields.push(field); } @@ -306,7 +306,7 @@ pub fn derive_as_bind_group(ast: syn::DeriveInput) -> Result { let mut field_struct_impls = Vec::new(); for (binding_index, binding_state) in binding_states.iter().enumerate() { let binding_index = binding_index as u32; - if let BindingState::OccupiedMergableUniform { uniform_fields } = binding_state { + if let BindingState::OccupiedMergeableUniform { uniform_fields } = binding_state { let binding_vec_index = bind_group_entries.len(); bind_group_entries.push(quote! { #render_path::render_resource::BindGroupEntry { diff --git a/crates/bevy_render/src/render_resource/pipeline_cache.rs b/crates/bevy_render/src/render_resource/pipeline_cache.rs index 36c54e6043..8961929218 100644 --- a/crates/bevy_render/src/render_resource/pipeline_cache.rs +++ b/crates/bevy_render/src/render_resource/pipeline_cache.rs @@ -806,7 +806,7 @@ fn log_shader_error(source: &ProcessedShader, error: &AsModuleDescriptorError) { #[derive(Error, Debug)] pub enum PipelineCacheError { #[error( - "Pipeline cound not be compiled because the following shader is not loaded yet: {0:?}" + "Pipeline could not be compiled because the following shader is not loaded yet: {0:?}" )] ShaderNotLoaded(Handle), #[error(transparent)] diff --git a/crates/bevy_tasks/src/task_pool.rs b/crates/bevy_tasks/src/task_pool.rs index 250bfba91f..5ded048186 100644 --- a/crates/bevy_tasks/src/task_pool.rs +++ b/crates/bevy_tasks/src/task_pool.rs @@ -710,7 +710,7 @@ mod tests { scope.spawn_on_scope(async move { inner_count_clone.fetch_add(1, Ordering::Release); if std::thread::current().id() != spawner { - // NOTE: This check is using an atomic rather than simply panicing the + // NOTE: This check is using an atomic rather than simply panicking the // thread to avoid deadlocking the barrier on failure inner_thread_check_failed.store(true, Ordering::Release); } @@ -785,7 +785,7 @@ mod tests { scope.spawn_on_scope(async move { inner_count_clone.fetch_add(1, Ordering::Release); if std::thread::current().id() != spawner { - // NOTE: This check is using an atomic rather than simply panicing the + // NOTE: This check is using an atomic rather than simply panicking the // thread to avoid deadlocking the barrier on failure inner_thread_check_failed.store(true, Ordering::Release); } diff --git a/crates/bevy_utils/src/lib.rs b/crates/bevy_utils/src/lib.rs index a6a4aebcb2..3ac1468973 100644 --- a/crates/bevy_utils/src/lib.rs +++ b/crates/bevy_utils/src/lib.rs @@ -253,7 +253,7 @@ impl PreHashMapExt for PreHashMap + |
badge
|
description
|code| |-|-|-| diff --git a/errors/B0001.md b/errors/B0001.md index 8c24a57c12..cd14977fe1 100644 --- a/errors/B0001.md +++ b/errors/B0001.md @@ -34,7 +34,7 @@ You have two solutions: Solution #1: use disjoint queries using [`Without`](https://docs.rs/bevy/*/bevy/ecs/query/struct.Without.html) -As a `Player` entity won't be an `Enemy` at the same time, those two queries will acutally never target the same entity. This can be encoded in the query filter with [`Without`](https://docs.rs/bevy/*/bevy/ecs/query/struct.Without.html): +As a `Player` entity won't be an `Enemy` at the same time, those two queries will actually never target the same entity. This can be encoded in the query filter with [`Without`](https://docs.rs/bevy/*/bevy/ecs/query/struct.Without.html): ```rust,no_run use bevy::prelude::*; diff --git a/errors/B0003.md b/errors/B0003.md index 13d60a84c6..9fd3c5b28e 100644 --- a/errors/B0003.md +++ b/errors/B0003.md @@ -51,7 +51,7 @@ thread 'main' panicked at 'error[B0003]: Could not add a component (of type `use But you don't know which system tried to add a component, and which system despawned the entity. -To get the system that created the command that panics, you can enable the `trace` feature of Bevy. This will add a panic handler that will print more informations: +To get the system that created the command that panics, you can enable the `trace` feature of Bevy. This will add a panic handler that will print more information: ```text 0: bevy_ecs::schedule::stage::system_commands @@ -78,7 +78,7 @@ thread 'main' panicked at 'error[B0003]: Could not add a component (of type `use From the first line, you know the entity `0v0` was despawned when executing a command from system `despawning`. In a real case, you could have many log lines, you will need to search for the exact entity from the panic message. -Combining those two, you should get enough informations to understand why this panic is happening and how to fix it: +Combining those two, you should get enough information to understand why this panic is happening and how to fix it: ```text DEBUG stage{name=Update}:system_commands{name="use_entity_after_despawn::despawning"}: bevy_ecs::world: Despawning entity 0v0 diff --git a/examples/README.md b/examples/README.md index 672053b436..f202483fd5 100644 --- a/examples/README.md +++ b/examples/README.md @@ -386,7 +386,7 @@ You can view the logs with the following command: adb logcat | grep 'RustStdoutStderr\|bevy\|wgpu' ``` -In case of an error getting a GPU or setting it up, you can try settings logs of `wgpu_hal` to `DEBUG` to get more informations. +In case of an error getting a GPU or setting it up, you can try settings logs of `wgpu_hal` to `DEBUG` to get more information. Sometimes, running the app complains about an unknown activity. This may be fixed by uninstalling the application: diff --git a/examples/README.md.tpl b/examples/README.md.tpl index bfb3ebdc4f..21e894198a 100644 --- a/examples/README.md.tpl +++ b/examples/README.md.tpl @@ -121,7 +121,7 @@ You can view the logs with the following command: adb logcat | grep 'RustStdoutStderr\|bevy\|wgpu' ``` -In case of an error getting a GPU or setting it up, you can try settings logs of `wgpu_hal` to `DEBUG` to get more informations. +In case of an error getting a GPU or setting it up, you can try settings logs of `wgpu_hal` to `DEBUG` to get more information. Sometimes, running the app complains about an unknown activity. This may be fixed by uninstalling the application: diff --git a/examples/ecs/component_change_detection.rs b/examples/ecs/component_change_detection.rs index c706f0fdb6..67d05f6fd0 100644 --- a/examples/ecs/component_change_detection.rs +++ b/examples/ecs/component_change_detection.rs @@ -26,7 +26,7 @@ fn change_component(time: Res