Skip to content

Commit d86fae8

Browse files
authored
Update docs for Updated, Changed and Mutated (#451)
Update docs for Updated, Changed and Mutated
1 parent 54e9f44 commit d86fae8

File tree

1 file changed

+4
-6
lines changed

1 file changed

+4
-6
lines changed

crates/bevy_ecs/hecs/src/query.rs

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -322,9 +322,8 @@ pub struct Or<T>(PhantomData<T>);
322322
#[doc(hidden)]
323323
pub struct FetchOr<T>(T);
324324

325-
/// Query transformer that skips entities that have a `T` component that has
326-
/// not been mutated since the last pass of the system. This does not include
327-
/// components that were added in since the last pass.
325+
/// Query transformer that retrieves components of type `T` that have been mutated since the start of the frame.
326+
/// Added components do not count as mutated.
328327
pub struct Mutated<'a, T> {
329328
value: &'a T,
330329
}
@@ -389,7 +388,7 @@ impl<'a, T: Component> Fetch<'a> for FetchMutated<T> {
389388
}
390389
}
391390

392-
#[allow(missing_docs)]
391+
/// Query transformer that retrieves components of type `T` that have been added since the start of the frame.
393392
pub struct Added<'a, T> {
394393
value: &'a T,
395394
}
@@ -452,8 +451,7 @@ impl<'a, T: Component> Fetch<'a> for FetchAdded<T> {
452451
}
453452
}
454453

455-
/// Query transformer skipping entities that have not been either mutated or added
456-
/// since the last pass of the system
454+
/// Query transformer that retrieves components of type `T` that have either been mutated or added since the start of the frame.
457455
pub struct Changed<'a, T> {
458456
value: &'a T,
459457
}

0 commit comments

Comments
 (0)