From b77e3ef33a782b870d4a22c7b9513db75bd812a7 Mon Sep 17 00:00:00 2001 From: Rob Parrett Date: Fri, 10 Jan 2025 14:48:30 -0800 Subject: [PATCH] Fix a few typos (#17292) # Objective Stumbled upon a `from <-> form` transposition while reviewing a PR, thought it was interesting, and went down a bit of a rabbit hole. ## Solution Fix em --- crates/bevy_animation/src/animatable.rs | 2 +- crates/bevy_animation/src/lib.rs | 2 +- crates/bevy_app/src/app.rs | 4 ++-- crates/bevy_asset/src/asset_changed.rs | 6 +++--- crates/bevy_core_pipeline/src/smaa/smaa.wgsl | 2 +- crates/bevy_core_pipeline/src/upscaling/mod.rs | 2 +- crates/bevy_ecs/src/query/iter.rs | 4 ++-- crates/bevy_ecs/src/query/world_query.rs | 2 +- crates/bevy_ecs/src/schedule/config.rs | 2 +- crates/bevy_ecs/src/schedule/graph/graph_map.rs | 2 +- crates/bevy_ecs/src/storage/table/mod.rs | 6 +++--- crates/bevy_ecs/src/system/builder.rs | 2 +- crates/bevy_gizmos/src/primitives/dim3.rs | 2 +- crates/bevy_gizmos/src/primitives/helpers.rs | 2 +- crates/bevy_gltf/src/loader.rs | 4 ++-- crates/bevy_input/src/common_conditions.rs | 2 +- crates/bevy_math/src/bounding/bounded2d/primitive_impls.rs | 2 +- crates/bevy_math/src/curve/cores.rs | 2 +- crates/bevy_pbr/src/light/mod.rs | 2 +- crates/bevy_pbr/src/wireframe.rs | 2 +- crates/bevy_reflect/src/reflect.rs | 2 +- crates/bevy_render/src/mesh/allocator.rs | 2 +- crates/bevy_render/src/render_phase/mod.rs | 2 +- crates/bevy_render/src/render_resource/pipeline_cache.rs | 4 ++-- crates/bevy_scene/src/scene_spawner.rs | 2 +- crates/bevy_sprite/src/texture_slice/mod.rs | 2 +- crates/bevy_tasks/src/task_pool.rs | 2 +- crates/bevy_utils/src/syncunsafecell.rs | 2 +- crates/bevy_window/src/event.rs | 2 +- docs-template/EXAMPLE_README.md.tpl | 2 +- docs/linux_dependencies.md | 2 +- examples/README.md | 2 +- examples/animation/custom_skinned_mesh.rs | 2 +- examples/ecs/system_piping.rs | 2 +- examples/ui/directional_navigation.rs | 2 +- examples/window/window_drag_move.rs | 2 +- 36 files changed, 44 insertions(+), 44 deletions(-) diff --git a/crates/bevy_animation/src/animatable.rs b/crates/bevy_animation/src/animatable.rs index 4def754906..a345c5fce4 100644 --- a/crates/bevy_animation/src/animatable.rs +++ b/crates/bevy_animation/src/animatable.rs @@ -18,7 +18,7 @@ pub struct BlendInput { /// An animatable value type. pub trait Animatable: Reflect + Sized + Send + Sync + 'static { - /// Interpolates between `a` and `b` with a interpolation factor of `time`. + /// Interpolates between `a` and `b` with an interpolation factor of `time`. /// /// The `time` parameter here may not be clamped to the range `[0.0, 1.0]`. fn interpolate(a: &Self, b: &Self, time: f32) -> Self; diff --git a/crates/bevy_animation/src/lib.rs b/crates/bevy_animation/src/lib.rs index feb0a327d6..25686b4916 100644 --- a/crates/bevy_animation/src/lib.rs +++ b/crates/bevy_animation/src/lib.rs @@ -469,7 +469,7 @@ pub enum AnimationEvaluationError { /// An animation that an [`AnimationPlayer`] is currently either playing or was /// playing, but is presently paused. /// -/// An stopped animation is considered no longer active. +/// A stopped animation is considered no longer active. #[derive(Debug, Clone, Copy, Reflect)] pub struct ActiveAnimation { /// The factor by which the weight from the [`AnimationGraph`] is multiplied. diff --git a/crates/bevy_app/src/app.rs b/crates/bevy_app/src/app.rs index 8a6f4745d2..6ff5b9993d 100644 --- a/crates/bevy_app/src/app.rs +++ b/crates/bevy_app/src/app.rs @@ -1357,7 +1357,7 @@ pub enum AppExit { } impl AppExit { - /// Creates a [`AppExit::Error`] with a error code of 1. + /// Creates a [`AppExit::Error`] with an error code of 1. #[must_use] pub const fn error() -> Self { Self::Error(NonZero::::MIN) @@ -1733,7 +1733,7 @@ mod tests { #[test] fn app_exit_size() { - // There wont be many of them so the size isn't a issue but + // There wont be many of them so the size isn't an issue but // it's nice they're so small let's keep it that way. assert_eq!(size_of::(), size_of::()); } diff --git a/crates/bevy_asset/src/asset_changed.rs b/crates/bevy_asset/src/asset_changed.rs index ca269ef52e..cb9f95defa 100644 --- a/crates/bevy_asset/src/asset_changed.rs +++ b/crates/bevy_asset/src/asset_changed.rs @@ -86,7 +86,7 @@ impl<'w, A: AsAssetId> AssetChangeCheck<'w, A> { } } -/// Filter that selects entities with a `A` for an asset that changed +/// Filter that selects entities with an `A` for an asset that changed /// after the system last ran, where `A` is a component that implements /// [`AsAssetId`]. /// @@ -114,8 +114,8 @@ impl<'w, A: AsAssetId> AssetChangeCheck<'w, A> { /// # Performance /// /// When at least one `A` is updated, this will -/// read a hashmap once per entity with a `A` component. The -/// runtime of the query is proportional to how many entities with a `A` +/// read a hashmap once per entity with an `A` component. The +/// runtime of the query is proportional to how many entities with an `A` /// it matches. /// /// If no `A` asset updated since the last time the system ran, then no lookups occur. diff --git a/crates/bevy_core_pipeline/src/smaa/smaa.wgsl b/crates/bevy_core_pipeline/src/smaa/smaa.wgsl index 3542afbe12..0872325448 100644 --- a/crates/bevy_core_pipeline/src/smaa/smaa.wgsl +++ b/crates/bevy_core_pipeline/src/smaa/smaa.wgsl @@ -429,7 +429,7 @@ const SMAA_CORNER_ROUNDING: u32 = 25u; // "SMAA Presets".) /** - * If there is an neighbor edge that has SMAA_LOCAL_CONTRAST_FACTOR times + * If there is a neighbor edge that has SMAA_LOCAL_CONTRAST_FACTOR times * bigger contrast than current edge, current edge will be discarded. * * This allows to eliminate spurious crossing edges, and is based on the fact diff --git a/crates/bevy_core_pipeline/src/upscaling/mod.rs b/crates/bevy_core_pipeline/src/upscaling/mod.rs index 52369fca59..1145e17d18 100644 --- a/crates/bevy_core_pipeline/src/upscaling/mod.rs +++ b/crates/bevy_core_pipeline/src/upscaling/mod.rs @@ -55,7 +55,7 @@ fn prepare_view_upscaling_pipelines( match blend_state { None => { - // If we've already seen this output for a camera and it doesn't have a output blend + // If we've already seen this output for a camera and it doesn't have an output blend // mode configured, default to alpha blend so that we don't accidentally overwrite // the output texture if already_seen { diff --git a/crates/bevy_ecs/src/query/iter.rs b/crates/bevy_ecs/src/query/iter.rs index 0f4cfe2bed..13eaf3f08c 100644 --- a/crates/bevy_ecs/src/query/iter.rs +++ b/crates/bevy_ecs/src/query/iter.rs @@ -126,7 +126,7 @@ impl<'w, 's, D: QueryData, F: QueryFilter> QueryIter<'w, 's, D, F> { } /// Executes the equivalent of [`Iterator::fold`] over a contiguous segment - /// from an storage. + /// from a storage. /// /// # Safety /// - `range` must be in `[0, storage::entity_count)` or None. @@ -187,7 +187,7 @@ impl<'w, 's, D: QueryData, F: QueryFilter> QueryIter<'w, 's, D, F> { } /// Executes the equivalent of [`Iterator::fold`] over a contiguous segment - /// from an table. + /// from a table. /// /// # Safety /// - all `rows` must be in `[0, table.entity_count)`. diff --git a/crates/bevy_ecs/src/query/world_query.rs b/crates/bevy_ecs/src/query/world_query.rs index 422a1c8cd0..3f9111ff3c 100644 --- a/crates/bevy_ecs/src/query/world_query.rs +++ b/crates/bevy_ecs/src/query/world_query.rs @@ -116,7 +116,7 @@ pub unsafe trait WorldQuery { /// Fetch [`Self::Item`](`WorldQuery::Item`) for either the given `entity` in the current [`Table`], /// or for the given `entity` in the current [`Archetype`]. This must always be called after /// [`WorldQuery::set_table`] with a `table_row` in the range of the current [`Table`] or after - /// [`WorldQuery::set_archetype`] with a `entity` in the current archetype. + /// [`WorldQuery::set_archetype`] with an `entity` in the current archetype. /// Accesses components registered in [`WorldQuery::update_component_access`]. /// /// # Safety diff --git a/crates/bevy_ecs/src/schedule/config.rs b/crates/bevy_ecs/src/schedule/config.rs index 97b6392f85..909aca8775 100644 --- a/crates/bevy_ecs/src/schedule/config.rs +++ b/crates/bevy_ecs/src/schedule/config.rs @@ -431,7 +431,7 @@ where /// /// Ordering constraints will be applied between the successive elements. /// - /// If the preceding node on a edge has deferred parameters, a [`ApplyDeferred`](crate::schedule::ApplyDeferred) + /// If the preceding node on an edge has deferred parameters, an [`ApplyDeferred`](crate::schedule::ApplyDeferred) /// will be inserted on the edge. If this behavior is not desired consider using /// [`chain_ignore_deferred`](Self::chain_ignore_deferred) instead. fn chain(self) -> SystemConfigs { diff --git a/crates/bevy_ecs/src/schedule/graph/graph_map.rs b/crates/bevy_ecs/src/schedule/graph/graph_map.rs index 66ae7a08f5..35f3260d3e 100644 --- a/crates/bevy_ecs/src/schedule/graph/graph_map.rs +++ b/crates/bevy_ecs/src/schedule/graph/graph_map.rs @@ -32,7 +32,7 @@ pub type DiGraph = Graph; /// `Graph` is a graph datastructure using an associative array /// of its node weights `NodeId`. /// -/// It uses an combined adjacency list and sparse adjacency matrix +/// It uses a combined adjacency list and sparse adjacency matrix /// representation, using **O(|N| + |E|)** space, and allows testing for edge /// existence in constant time. /// diff --git a/crates/bevy_ecs/src/storage/table/mod.rs b/crates/bevy_ecs/src/storage/table/mod.rs index ce33890751..25c343a531 100644 --- a/crates/bevy_ecs/src/storage/table/mod.rs +++ b/crates/bevy_ecs/src/storage/table/mod.rs @@ -85,11 +85,11 @@ impl TableId { } } -/// A opaque newtype for rows in [`Table`]s. Specifies a single row in a specific table. +/// An opaque newtype for rows in [`Table`]s. Specifies a single row in a specific table. /// /// Values of this type are retrievable from [`Archetype::entity_table_row`] and can be /// used alongside [`Archetype::table_id`] to fetch the exact table and row where an -/// [`Entity`]'s +/// [`Entity`]'s components are stored. /// /// Values of this type are only valid so long as entities have not moved around. /// Adding and removing components from an entity, or despawning it will invalidate @@ -183,7 +183,7 @@ impl TableBuilder { /// A column-oriented [structure-of-arrays] based storage for [`Component`]s of entities /// in a [`World`]. /// -/// Conceptually, a `Table` can be thought of as an `HashMap`, where +/// Conceptually, a `Table` can be thought of as a `HashMap`, where /// each [`ThinColumn`] is a type-erased `Vec`. Each row corresponds to a single entity /// (i.e. index 3 in Column A and index 3 in Column B point to different components on the same /// entity). Fetching components from a table involves fetching the associated column for a diff --git a/crates/bevy_ecs/src/system/builder.rs b/crates/bevy_ecs/src/system/builder.rs index 9e7a015006..7257c827e1 100644 --- a/crates/bevy_ecs/src/system/builder.rs +++ b/crates/bevy_ecs/src/system/builder.rs @@ -240,7 +240,7 @@ unsafe impl<'w, 's, D: QueryData + 'static, F: QueryFilter + 'static> /// .build_state(&mut world) /// .build_system(|query: Query<()>| { /// for _ in &query { -/// // This only includes entities with an `Player` component. +/// // This only includes entities with a `Player` component. /// } /// }); /// diff --git a/crates/bevy_gizmos/src/primitives/dim3.rs b/crates/bevy_gizmos/src/primitives/dim3.rs index 1af21869a9..b99ab9a31a 100644 --- a/crates/bevy_gizmos/src/primitives/dim3.rs +++ b/crates/bevy_gizmos/src/primitives/dim3.rs @@ -413,7 +413,7 @@ where Config: GizmoConfigGroup, Clear: 'static + Send + Sync, { - /// Set the number of lines used to approximate the top an bottom of the cylinder geometry. + /// Set the number of lines used to approximate the top and bottom of the cylinder geometry. pub fn resolution(mut self, resolution: u32) -> Self { self.resolution = resolution; self diff --git a/crates/bevy_gizmos/src/primitives/helpers.rs b/crates/bevy_gizmos/src/primitives/helpers.rs index f6cdfcf0d3..37253b14a9 100644 --- a/crates/bevy_gizmos/src/primitives/helpers.rs +++ b/crates/bevy_gizmos/src/primitives/helpers.rs @@ -15,7 +15,7 @@ pub(crate) fn single_circle_coordinate(radius: f32, resolution: u32, nth_point: /// Generates an iterator over the coordinates of a circle. /// -/// The coordinates form a open circle, meaning the first and last points aren't the same. +/// The coordinates form an open circle, meaning the first and last points aren't the same. /// /// This function creates an iterator that yields the positions of points approximating a /// circle with the given radius, divided into linear segments. The iterator produces `resolution` diff --git a/crates/bevy_gltf/src/loader.rs b/crates/bevy_gltf/src/loader.rs index bb744e82b4..e83ed9351f 100644 --- a/crates/bevy_gltf/src/loader.rs +++ b/crates/bevy_gltf/src/loader.rs @@ -1805,7 +1805,7 @@ fn texture_sampler(texture: &gltf::Texture) -> ImageSamplerDescriptor { } } -/// Maps the texture address mode form glTF to wgpu. +/// Maps the texture address mode from glTF to wgpu. fn texture_address_mode(gltf_address_mode: &WrappingMode) -> ImageAddressMode { match gltf_address_mode { WrappingMode::ClampToEdge => ImageAddressMode::ClampToEdge, @@ -1814,7 +1814,7 @@ fn texture_address_mode(gltf_address_mode: &WrappingMode) -> ImageAddressMode { } } -/// Maps the `primitive_topology` form glTF to `wgpu`. +/// Maps the `primitive_topology` from glTF to `wgpu`. #[expect( clippy::result_large_err, reason = "`GltfError` is only barely past the threshold for large errors." diff --git a/crates/bevy_input/src/common_conditions.rs b/crates/bevy_input/src/common_conditions.rs index bc2e161b1b..560ea693d9 100644 --- a/crates/bevy_input/src/common_conditions.rs +++ b/crates/bevy_input/src/common_conditions.rs @@ -2,7 +2,7 @@ use crate::ButtonInput; use bevy_ecs::system::Res; use core::hash::Hash; -/// Stateful run condition that can be toggled via a input press using [`ButtonInput::just_pressed`]. +/// Stateful run condition that can be toggled via an input press using [`ButtonInput::just_pressed`]. /// /// ```no_run /// # use bevy_app::{App, NoopPluginGroup as DefaultPlugins, Update}; diff --git a/crates/bevy_math/src/bounding/bounded2d/primitive_impls.rs b/crates/bevy_math/src/bounding/bounded2d/primitive_impls.rs index fa0292572f..e6c0813688 100644 --- a/crates/bevy_math/src/bounding/bounded2d/primitive_impls.rs +++ b/crates/bevy_math/src/bounding/bounded2d/primitive_impls.rs @@ -651,7 +651,7 @@ mod tests { let apothem = ops::sqrt(3.0) / 2.0; let inv_sqrt_3 = ops::sqrt(3.0).recip(); let tests = [ - // Test case: An sector whose arc is minor, but whose bounding circle is not the circumcircle of the endpoints and center + // Test case: A sector whose arc is minor, but whose bounding circle is not the circumcircle of the endpoints and center TestCase { name: "1/3rd circle", arc: Arc2d::from_radians(1.0, TAU / 3.0), diff --git a/crates/bevy_math/src/curve/cores.rs b/crates/bevy_math/src/curve/cores.rs index 35bffe9018..838d0d116d 100644 --- a/crates/bevy_math/src/curve/cores.rs +++ b/crates/bevy_math/src/curve/cores.rs @@ -147,7 +147,7 @@ pub enum EvenCoreError { }, /// Unbounded domains are not compatible with `EvenCore`. - #[error("Cannot create a EvenCore over an unbounded domain")] + #[error("Cannot create an EvenCore over an unbounded domain")] UnboundedDomain, } diff --git a/crates/bevy_pbr/src/light/mod.rs b/crates/bevy_pbr/src/light/mod.rs index fe99f1bbdc..5525029ef4 100644 --- a/crates/bevy_pbr/src/light/mod.rs +++ b/crates/bevy_pbr/src/light/mod.rs @@ -78,7 +78,7 @@ pub mod light_consts { pub const OFFICE: f32 = 320.; /// The amount of light (lux) during sunrise or sunset on a clear day. pub const CLEAR_SUNRISE: f32 = 400.; - /// The amount of light (lux) on a overcast day; typical TV studio lighting + /// The amount of light (lux) on an overcast day; typical TV studio lighting pub const OVERCAST_DAY: f32 = 1000.; /// The amount of light (lux) from ambient daylight (not direct sunlight). pub const AMBIENT_DAYLIGHT: f32 = 10_000.; diff --git a/crates/bevy_pbr/src/wireframe.rs b/crates/bevy_pbr/src/wireframe.rs index 5181e4a970..aaec62986f 100644 --- a/crates/bevy_pbr/src/wireframe.rs +++ b/crates/bevy_pbr/src/wireframe.rs @@ -203,7 +203,7 @@ fn apply_global_wireframe_material( } } -/// Gets an handle to a wireframe material with a fallback on the default material +/// Gets a handle to a wireframe material with a fallback on the default material fn get_wireframe_material( maybe_color: Option<&WireframeColor>, wireframe_materials: &mut Assets, diff --git a/crates/bevy_reflect/src/reflect.rs b/crates/bevy_reflect/src/reflect.rs index 0af2908119..0898ff3630 100644 --- a/crates/bevy_reflect/src/reflect.rs +++ b/crates/bevy_reflect/src/reflect.rs @@ -17,7 +17,7 @@ use crate::utility::NonGenericTypeInfoCell; #[derive(Error, Debug)] pub enum ApplyError { #[error("attempted to apply `{from_kind}` to `{to_kind}`")] - /// Attempted to apply the wrong [kind](ReflectKind) to a type, e.g. a struct to a enum. + /// Attempted to apply the wrong [kind](ReflectKind) to a type, e.g. a struct to an enum. MismatchedKinds { from_kind: ReflectKind, to_kind: ReflectKind, diff --git a/crates/bevy_render/src/mesh/allocator.rs b/crates/bevy_render/src/mesh/allocator.rs index f1c4394424..f144b37163 100644 --- a/crates/bevy_render/src/mesh/allocator.rs +++ b/crates/bevy_render/src/mesh/allocator.rs @@ -861,7 +861,7 @@ impl MeshAllocator { } impl GeneralSlab { - /// Creates a new growable slab big enough to hold an single element of + /// Creates a new growable slab big enough to hold a single element of /// `data_slot_count` size with the given `layout`. fn new( new_slab_id: SlabId, diff --git a/crates/bevy_render/src/render_phase/mod.rs b/crates/bevy_render/src/render_phase/mod.rs index e3814eb75f..6f22d4ee07 100644 --- a/crates/bevy_render/src/render_phase/mod.rs +++ b/crates/bevy_render/src/render_phase/mod.rs @@ -1202,7 +1202,7 @@ pub trait SortedPhaseItem: PhaseItem { /// Sorts a slice of phase items into render order. Generally if the same type /// is batched this should use a stable sort like [`slice::sort_by_key`]. /// In almost all other cases, this should not be altered from the default, - /// which uses a unstable sort, as this provides the best balance of CPU and GPU + /// which uses an unstable sort, as this provides the best balance of CPU and GPU /// performance. /// /// Implementers can optionally not sort the list at all. This is generally advisable if and diff --git a/crates/bevy_render/src/render_resource/pipeline_cache.rs b/crates/bevy_render/src/render_resource/pipeline_cache.rs index 8bc4edbeb9..29cca0aba0 100644 --- a/crates/bevy_render/src/render_resource/pipeline_cache.rs +++ b/crates/bevy_render/src/render_resource/pipeline_cache.rs @@ -26,7 +26,7 @@ use wgpu::{ /// A descriptor for a [`Pipeline`]. /// -/// Used to store an heterogenous collection of render and compute pipeline descriptors together. +/// Used to store a heterogenous collection of render and compute pipeline descriptors together. #[derive(Debug)] pub enum PipelineDescriptor { RenderPipelineDescriptor(Box), @@ -35,7 +35,7 @@ pub enum PipelineDescriptor { /// A pipeline defining the data layout and shader logic for a specific GPU task. /// -/// Used to store an heterogenous collection of render and compute pipelines together. +/// Used to store a heterogenous collection of render and compute pipelines together. #[derive(Debug)] pub enum Pipeline { RenderPipeline(RenderPipeline), diff --git a/crates/bevy_scene/src/scene_spawner.rs b/crates/bevy_scene/src/scene_spawner.rs index 7e18bdc001..0f47710446 100644 --- a/crates/bevy_scene/src/scene_spawner.rs +++ b/crates/bevy_scene/src/scene_spawner.rs @@ -403,7 +403,7 @@ impl SceneSpawner { } } - /// Check that an scene instance spawned previously is ready to use + /// Check that a scene instance spawned previously is ready to use pub fn instance_is_ready(&self, instance_id: InstanceId) -> bool { self.spawned_instances.contains_key(&instance_id) } diff --git a/crates/bevy_sprite/src/texture_slice/mod.rs b/crates/bevy_sprite/src/texture_slice/mod.rs index 88939df91f..7ea01d5839 100644 --- a/crates/bevy_sprite/src/texture_slice/mod.rs +++ b/crates/bevy_sprite/src/texture_slice/mod.rs @@ -22,7 +22,7 @@ pub struct TextureSlice { } impl TextureSlice { - /// Transforms the given slice in an collection of tiled subdivisions. + /// Transforms the given slice in a collection of tiled subdivisions. /// /// # Arguments /// diff --git a/crates/bevy_tasks/src/task_pool.rs b/crates/bevy_tasks/src/task_pool.rs index 9e5509300f..c16aeca355 100644 --- a/crates/bevy_tasks/src/task_pool.rs +++ b/crates/bevy_tasks/src/task_pool.rs @@ -334,7 +334,7 @@ impl TaskPool { T: Send + 'static, { Self::THREAD_EXECUTOR.with(|scope_executor| { - // If a `external_executor` is passed use that. Otherwise get the executor stored + // If an `external_executor` is passed, use that. Otherwise, get the executor stored // in the `THREAD_EXECUTOR` thread local. if let Some(external_executor) = external_executor { self.scope_with_executor_inner( diff --git a/crates/bevy_utils/src/syncunsafecell.rs b/crates/bevy_utils/src/syncunsafecell.rs index 0a4e427fe4..104256969d 100644 --- a/crates/bevy_utils/src/syncunsafecell.rs +++ b/crates/bevy_utils/src/syncunsafecell.rs @@ -115,7 +115,7 @@ impl SyncUnsafeCell<[T]> { } impl Default for SyncUnsafeCell { - /// Creates an `SyncUnsafeCell`, with the `Default` value for T. + /// Creates a new `SyncUnsafeCell` with the `Default` value for T. fn default() -> SyncUnsafeCell { SyncUnsafeCell::new(Default::default()) } diff --git a/crates/bevy_window/src/event.rs b/crates/bevy_window/src/event.rs index 714df2dc9a..ace66efb6c 100644 --- a/crates/bevy_window/src/event.rs +++ b/crates/bevy_window/src/event.rs @@ -194,7 +194,7 @@ pub struct CursorLeft { pub window: Entity, } -/// A Input Method Editor event. +/// An Input Method Editor event. /// /// This event is the translated version of the `WindowEvent::Ime` from the `winit` crate. /// diff --git a/docs-template/EXAMPLE_README.md.tpl b/docs-template/EXAMPLE_README.md.tpl index 6a821362d1..fd5c9aa014 100644 --- a/docs-template/EXAMPLE_README.md.tpl +++ b/docs-template/EXAMPLE_README.md.tpl @@ -265,7 +265,7 @@ Bevy support for WebGPU is being worked on, but is currently experimental. To build for WebGPU, you'll need to enable the `webgpu` feature. This will override the `webgl2` feature, and builds with the `webgpu` feature enabled won't be able to run on browsers that don't support WebGPU. -Bevy has an helper to build its examples: +Bevy has a helper to build its examples: - Build for WebGL2: `cargo run -p build-wasm-example -- --api webgl2 load_gltf` - Build for WebGPU: `cargo run -p build-wasm-example -- --api webgpu load_gltf` diff --git a/docs/linux_dependencies.md b/docs/linux_dependencies.md index 32d387f5ce..d652cee1fd 100644 --- a/docs/linux_dependencies.md +++ b/docs/linux_dependencies.md @@ -137,7 +137,7 @@ You can do this in one line with `nix-shell --run "cargo run"`. If running nix on a non NixOS system (such as ubuntu, arch etc.), [NixGL](https://github.com/nix-community/nixGL) is additionally required, to link graphics drivers into the context of software installed by nix: -1. Install an system specific nixGL wrapper ([docs](https://github.com/nix-community/nixGL)). +1. Install a system specific nixGL wrapper ([docs](https://github.com/nix-community/nixGL)). * If you're running a nvidia GPU choose `nixVulkanNvidia`. * Otherwise, choose another wrapper appropriate for your system. 2. Run `nixVulkanNvidia-xxx.xxx.xx cargo run` to compile a bevy program, where `xxx-xxx-xx` denotes the graphics driver version `nixVulkanNvidia` was compiled with. diff --git a/examples/README.md b/examples/README.md index e85156ca01..b1a97eef77 100644 --- a/examples/README.md +++ b/examples/README.md @@ -742,7 +742,7 @@ Bevy support for WebGPU is being worked on, but is currently experimental. To build for WebGPU, you'll need to enable the `webgpu` feature. This will override the `webgl2` feature, and builds with the `webgpu` feature enabled won't be able to run on browsers that don't support WebGPU. -Bevy has an helper to build its examples: +Bevy has a helper to build its examples: - Build for WebGL2: `cargo run -p build-wasm-example -- --api webgl2 load_gltf` - Build for WebGPU: `cargo run -p build-wasm-example -- --api webgpu load_gltf` diff --git a/examples/animation/custom_skinned_mesh.rs b/examples/animation/custom_skinned_mesh.rs index 607be38e6d..b091f2dd42 100644 --- a/examples/animation/custom_skinned_mesh.rs +++ b/examples/animation/custom_skinned_mesh.rs @@ -134,7 +134,7 @@ fn setup( ], ) // Tell bevy to construct triangles from a list of vertex indices, - // where each 3 vertex indices form an triangle. + // where each 3 vertex indices form a triangle. .with_inserted_indices(Indices::U16(vec![ 0, 1, 3, 0, 3, 2, 2, 3, 5, 2, 5, 4, 4, 5, 7, 4, 7, 6, 6, 7, 9, 6, 9, 8, ])); diff --git a/examples/ecs/system_piping.rs b/examples/ecs/system_piping.rs index dec148cdfc..a3607c085d 100644 --- a/examples/ecs/system_piping.rs +++ b/examples/ecs/system_piping.rs @@ -69,7 +69,7 @@ fn data_pipe_system(message: Res) -> String { message.0.clone() } -// This system produces an Result output by trying to extract a String from the +// This system produces a Result output by trying to extract a String from the // OptionalWarning resource. Try changing the OptionalWarning resource to None. You should // not see the warning message printed. fn warning_pipe_system(message: Res) -> Result<(), String> { diff --git a/examples/ui/directional_navigation.rs b/examples/ui/directional_navigation.rs index a5b4286405..d80b24f3b7 100644 --- a/examples/ui/directional_navigation.rs +++ b/examples/ui/directional_navigation.rs @@ -65,7 +65,7 @@ const FOCUSED_BORDER: Srgba = bevy::color::palettes::tailwind::BLUE_50; // In a real project, each button would also have its own unique behavior, // to capture the actual intent of the user fn universal_button_click_behavior( - // We're using a on-mouse-down trigger to improve responsiveness; + // We're using an on-mouse-down trigger to improve responsiveness; // Clicked is better when you want roll-off cancellation mut trigger: Trigger>, mut button_query: Query<(&mut BackgroundColor, &mut ResetTimer)>, diff --git a/examples/window/window_drag_move.rs b/examples/window/window_drag_move.rs index 99e77d08aa..7f112b4c8b 100644 --- a/examples/window/window_drag_move.rs +++ b/examples/window/window_drag_move.rs @@ -3,7 +3,7 @@ //! //! When window decorations are not present, the user cannot drag a window by //! its titlebar to change its position. The `start_drag_move()` function -//! permits a users to drag a window by left clicking anywhere in the window; +//! permits a user to drag a window by left clicking anywhere in the window; //! left click must be pressed and other constraints can be imposed. For //! instance an application could require a user to hold down alt and left click //! to drag a window.