Skip to content

Commit c406425

Browse files
tim-blackbirdItsDoot
authored andcommitted
Fix some grammatical errors in the docs (bevyengine#6109)
Co-authored-by: devil-ira <[email protected]>
1 parent 1044064 commit c406425

File tree

4 files changed

+13
-14
lines changed

4 files changed

+13
-14
lines changed

crates/bevy_hierarchy/src/events.rs

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,27 @@
11
use bevy_ecs::prelude::Entity;
22

3-
/// A [`Event`] that is fired whenever there is a change in the world's
4-
/// hierarchy.
3+
/// An [`Event`] that is fired whenever there is a change in the world's hierarchy.
54
///
65
/// [`Event`]: bevy_ecs::event::Event
76
#[derive(Debug, Clone)]
87
pub enum HierarchyEvent {
9-
/// Fired whenever an [`Entity`] is added as a child to a new parent.
8+
/// Fired whenever an [`Entity`] is added as a child to a parent.
109
ChildAdded {
11-
/// The child that added
10+
/// The child that was added
1211
child: Entity,
1312
/// The parent the child was added to
1413
parent: Entity,
1514
},
16-
/// Fired whenever an child [`Entity`] is removed from is parent.
15+
/// Fired whenever a child [`Entity`] is removed from its parent.
1716
ChildRemoved {
18-
/// The child that removed
17+
/// The child that was removed
1918
child: Entity,
2019
/// The parent the child was removed from
2120
parent: Entity,
2221
},
23-
/// Fired whenever an child [`Entity`] is moved to a new parent.
22+
/// Fired whenever a child [`Entity`] is moved to a new parent.
2423
ChildMoved {
25-
/// The child that moved
24+
/// The child that was moved
2625
child: Entity,
2726
/// The parent the child was removed from
2827
previous_parent: Entity,

crates/bevy_time/src/stopwatch.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,8 @@ impl Stopwatch {
5858
///
5959
/// # See Also
6060
///
61-
/// [`elapsed_secs`](Stopwatch::elapsed_secs) - if a `f32` value is desirable instead.
62-
/// [`elapsed_secs_f64`](Stopwatch::elapsed_secs_f64) - if a `f64` is desirable instead.
61+
/// [`elapsed_secs`](Stopwatch::elapsed_secs) - if an `f32` value is desirable instead.
62+
/// [`elapsed_secs_f64`](Stopwatch::elapsed_secs_f64) - if an `f64` is desirable instead.
6363
#[inline]
6464
pub fn elapsed(&self) -> Duration {
6565
self.elapsed
@@ -80,7 +80,7 @@ impl Stopwatch {
8080
/// # See Also
8181
///
8282
/// [`elapsed`](Stopwatch::elapsed) - if a `Duration` is desirable instead.
83-
/// [`elapsed_secs_f64`](Stopwatch::elapsed_secs_f64) - if a `f64` is desirable instead.
83+
/// [`elapsed_secs_f64`](Stopwatch::elapsed_secs_f64) - if an `f64` is desirable instead.
8484
#[inline]
8585
pub fn elapsed_secs(&self) -> f32 {
8686
self.elapsed().as_secs_f32()
@@ -92,7 +92,7 @@ impl Stopwatch {
9292
/// # See Also
9393
///
9494
/// [`elapsed`](Stopwatch::elapsed) - if a `Duration` is desirable instead.
95-
/// [`elapsed_secs`](Stopwatch::elapsed_secs) - if a `f32` is desirable instead.
95+
/// [`elapsed_secs`](Stopwatch::elapsed_secs) - if an `f32` is desirable instead.
9696
#[inline]
9797
pub fn elapsed_secs_f64(&self) -> f64 {
9898
self.elapsed().as_secs_f64()

crates/bevy_time/src/timer.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ impl Timer {
9898
self.stopwatch.elapsed()
9999
}
100100

101-
/// Returns the time elapsed on the timer as a `f32`.
101+
/// Returns the time elapsed on the timer as an `f32`.
102102
/// See also [`Timer::elapsed`](Timer::elapsed).
103103
#[inline]
104104
pub fn elapsed_secs(&self) -> f32 {

docs/profiling.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Runtime Flame Graph: `tracing` spans
44

5-
Bevy has built-in [tracing](https://github.com/tokio-rs/tracing) spans to make it cheap and easy to profile Bevy ECS systems, render logic, engine iternals, and user app code. Enable the `trace` cargo feature to enable Bevy's built-in spans.
5+
Bevy has built-in [tracing](https://github.com/tokio-rs/tracing) spans to make it cheap and easy to profile Bevy ECS systems, render logic, engine internals, and user app code. Enable the `trace` cargo feature to enable Bevy's built-in spans.
66

77
If you also want to include `wgpu` tracing spans when profiling, they are emitted at the `tracing` `info` level so you will need to make sure they are not filtered out by the `LogSettings` resource's `filter` member which defaults to `wgpu=error`. You can do this by setting the `RUST_LOG=info` environment variable when running your application.
88

0 commit comments

Comments
 (0)