Skip to content

Commit 0707c07

Browse files
✏️ Fix typos across bevy (bevyengine#16702)
# Objective Fixes typos in bevy project, following suggestion in bevyengine/bevy-website#1912 (review) ## Solution I used https://github.com/crate-ci/typos to find them. I included only the ones that feel undebatable too me, but I am not in game engine so maybe some terms are expected. I left out the following typos: - `reparametrize` => `reparameterize`: There are a lot of occurences, I believe this was expected - `semicircles` => `hemicircles`: 2 occurences, may mean something specific in geometry - `invertation` => `inversion`: may mean something specific - `unparented` => `parentless`: may mean something specific - `metalness` => `metallicity`: may mean something specific ## Testing - Did you test these changes? If so, how? I did not test the changes, most changes are related to raw text. I expect the others to be tested by the CI. - Are there any parts that need more testing? I do not think - How can other people (reviewers) test your changes? Is there anything specific they need to know? To me there is nothing to test - If relevant, what platforms did you test these changes on, and are there any important ones you can't test? --- ## Migration Guide > This section is optional. If there are no breaking changes, you can delete this section. (kept in case I include the `reparameterize` change here) - If this PR is a breaking change (relative to the last release of Bevy), describe how a user might need to migrate their code to support these changes - Simply adding new functionality is not a breaking change. - Fixing behavior that was definitely a bug, rather than a questionable design choice is not a breaking change. ## Questions - [x] Should I include the above typos? No (bevyengine#16702 (comment)) - [ ] Should I add `typos` to the CI? (I will check how to configure it properly) This project looks awesome, I really enjoy reading the progress made, thanks to everyone involved.
1 parent 48fb4aa commit 0707c07

File tree

31 files changed

+44
-44
lines changed

31 files changed

+44
-44
lines changed

crates/bevy_animation/src/lib.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -658,7 +658,7 @@ impl ActiveAnimation {
658658
///
659659
/// Note that any events between the current time and `seek_time`
660660
/// will be triggered on the next update.
661-
/// Use [`set_seek_time`](Self::set_seek_time) if this is undisered.
661+
/// Use [`set_seek_time`](Self::set_seek_time) if this is undesired.
662662
pub fn seek_to(&mut self, seek_time: f32) -> &mut Self {
663663
self.last_seek_time = Some(self.seek_time);
664664
self.seek_time = seek_time;
@@ -669,7 +669,7 @@ impl ActiveAnimation {
669669
///
670670
/// Note that any events between the current time and `0.0`
671671
/// will be triggered on the next update.
672-
/// Use [`set_seek_time`](Self::set_seek_time) if this is undisered.
672+
/// Use [`set_seek_time`](Self::set_seek_time) if this is undesired.
673673
pub fn rewind(&mut self) -> &mut Self {
674674
self.last_seek_time = Some(self.seek_time);
675675
self.seek_time = 0.0;

crates/bevy_asset/src/server/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1384,7 +1384,7 @@ impl AssetServer {
13841384
/// asset from being dropped.
13851385
/// If you have access to an asset's strong [`Handle`], you should prefer to call
13861386
/// [`AssetServer::wait_for_asset`]
1387-
/// or [`wait_for_assest_untyped`](Self::wait_for_asset_untyped) to ensure the asset finishes
1387+
/// or [`wait_for_asset_untyped`](Self::wait_for_asset_untyped) to ensure the asset finishes
13881388
/// loading.
13891389
///
13901390
/// # Errors

crates/bevy_core_pipeline/src/core_3d/camera_3d.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ pub struct Camera3d {
4242
///
4343
/// Roughly corresponds to how many “layers of transparency” are rendered for screen space
4444
/// specular transmissive objects. Each step requires making one additional
45-
/// texture copy, so it's recommended to keep this number to a resonably low value. Defaults to `1`.
45+
/// texture copy, so it's recommended to keep this number to a reasonably low value. Defaults to `1`.
4646
///
4747
/// ### Notes
4848
///

crates/bevy_core_pipeline/src/oit/mod.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ use crate::core_3d::{
3131
Camera3d,
3232
};
3333

34-
/// Module that defines the necesasry systems to resolve the OIT buffer and render it to the screen.
34+
/// Module that defines the necessary systems to resolve the OIT buffer and render it to the screen.
3535
pub mod resolve;
3636

3737
/// Shader handle for the shader that draws the transparent meshes to the OIT layers buffer.
@@ -186,7 +186,7 @@ fn check_msaa(cameras: Query<&Msaa, With<OrderIndependentTransparencySettings>>)
186186
}
187187

188188
/// Holds the buffers that contain the data of all OIT layers.
189-
/// We use one big buffer for the entire app. Each camaera will reuse it so it will
189+
/// We use one big buffer for the entire app. Each camera will reuse it so it will
190190
/// always be the size of the biggest OIT enabled camera.
191191
#[derive(Resource)]
192192
pub struct OitBuffers {

crates/bevy_ecs/src/schedule/executor/multi_threaded.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -298,7 +298,7 @@ impl<'scope, 'env: 'scope, 'sys> Context<'scope, 'env, 'sys> {
298298

299299
fn tick_executor(&self) {
300300
// Ensure that the executor handles any events pushed to the system_completion queue by this thread.
301-
// If this thread acquires the lock, the exector runs after the push() and they are processed.
301+
// If this thread acquires the lock, the executor runs after the push() and they are processed.
302302
// If this thread does not acquire the lock, then the is_empty() check on the other thread runs
303303
// after the lock is released, which is after try_lock() failed, which is after the push()
304304
// on this thread, so the is_empty() check will see the new events and loop.

crates/bevy_ecs/src/storage/thin_array_ptr.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ impl<T> ThinArrayPtr<T> {
144144
let ptr = unsafe { self.data.as_ptr().add(index) };
145145
// SAFETY:
146146
// - The pointer is properly aligned
147-
// - It is derefrancable (all in the same allocation)
147+
// - It is dereferenceable (all in the same allocation)
148148
// - `index` < `len` and the element is safe to write to, so its valid
149149
// - We have a reference to self, so no other mutable accesses to the element can occur
150150
unsafe {
@@ -166,7 +166,7 @@ impl<T> ThinArrayPtr<T> {
166166
let ptr = unsafe { self.data.as_ptr().add(index) };
167167
// SAFETY:
168168
// - The pointer is properly aligned
169-
// - It is derefrancable (all in the same allocation)
169+
// - It is dereferenceable (all in the same allocation)
170170
// - `index` < `len` and the element is safe to write to, so its valid
171171
// - We have a mutable reference to `self`
172172
unsafe {
@@ -294,7 +294,7 @@ impl<T> ThinArrayPtr<T> {
294294
#[inline]
295295
pub unsafe fn as_slice(&self, slice_len: usize) -> &[T] {
296296
// SAFETY:
297-
// - the data is valid - allocated with the same allocater
297+
// - the data is valid - allocated with the same allocator
298298
// - non-null and well-aligned
299299
// - we have a shared reference to self - the data will not be mutated during 'a
300300
unsafe { core::slice::from_raw_parts(self.data.as_ptr(), slice_len) }

crates/bevy_ecs/src/world/reflect.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ impl World {
164164
};
165165

166166
// HACK: Only required for the `None`-case/`else`-branch, but it borrows `self`, which will
167-
// already be mutablyy borrowed by `self.get_mut_by_id()`, and I didn't find a way around it.
167+
// already be mutably borrowed by `self.get_mut_by_id()`, and I didn't find a way around it.
168168
let component_name = self
169169
.components()
170170
.get_name(component_id)

crates/bevy_gizmos/src/primitives/helpers.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ use bevy_math::{ops, Vec2};
44

55
/// Calculates the `nth` coordinate of a circle.
66
///
7-
/// Given a circle's radiu and its resolution, this function computes the position
7+
/// Given a circle's radius and its resolution, this function computes the position
88
/// of the `nth` point along the circumference of the circle. The rotation starts at `(0.0, radius)`
99
/// and proceeds counter-clockwise.
1010
pub(crate) fn single_circle_coordinate(radius: f32, resolution: u32, nth_point: u32) -> Vec2 {

crates/bevy_gltf/src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -284,7 +284,7 @@ pub struct GltfSkin {
284284
pub name: String,
285285
/// All the nodes that form this skin.
286286
pub joints: Vec<Handle<GltfNode>>,
287-
/// Inverse-bind matricy of this skin.
287+
/// Inverse-bind matrices of this skin.
288288
pub inverse_bind_matrices: Handle<SkinnedMeshInverseBindposes>,
289289
/// Additional data.
290290
pub extras: Option<GltfExtras>,

crates/bevy_image/src/image_texture_conversion.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,7 @@ mod test {
229229

230230
let image = Image::from_dynamic(initial.clone(), true, RenderAssetUsages::RENDER_WORLD);
231231

232-
// NOTE: Fails if `is_srbg = false` or the dynamic image is of the type rgb8.
232+
// NOTE: Fails if `is_srgb = false` or the dynamic image is of the type rgb8.
233233
assert_eq!(initial, image.try_into_dynamic().unwrap());
234234
}
235235
}

0 commit comments

Comments
 (0)