Skip to content

Commit fdccab5

Browse files
Fix bugs in doc tests
1 parent f4f4445 commit fdccab5

File tree

1 file changed

+22
-21
lines changed

1 file changed

+22
-21
lines changed

crates/bevy_ecs/src/system/query.rs

Lines changed: 22 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -657,18 +657,18 @@ where
657657
///
658658
/// # Example
659659
/// ```rust
660-
/// # use bevy::ecs::prelude::*;
660+
/// # use bevy_ecs::prelude::*;
661661
/// #[derive(Component, PartialEq)]
662-
/// struct Name(String);
662+
/// struct Life(u64);
663663
///
664664
/// let world = World::new();
665-
/// let entity_1 = world.spawn().insert(Name("Ferris")).id();
666-
/// let entity_2 = world.spawn().insert(Name("Cart")).id();
665+
/// let entity_1 = world.spawn().insert(Life(1)).id();
666+
/// let entity_2 = world.spawn().insert(Life(2)).id();
667667
///
668-
/// let name_query = world.query::<Name>();
669-
/// let (entity_1_name, entity_2_name) = name_query.get_pair(entity_1, entity_2);
670-
/// asserteq!(entity_1_name, Name("Ferris"));
671-
/// asserteq!(entity_2_name, Name("Cart"));
668+
/// let life_query = world.query::<&Life>();
669+
/// let (entity_1_life, entity_2_life) = life_query.get_pair(entity_1, entity_2);
670+
/// assert_eq!(entity_1_life, Life(1));
671+
/// assert_eq!(entity_2_life, Life(2));
672672
#[inline]
673673
pub fn get_pair(
674674
&'s self,
@@ -692,22 +692,22 @@ where
692692
///
693693
/// # Example
694694
/// ```rust
695-
/// # use bevy::ecs::prelude::*;
695+
/// # use bevy_ecs::prelude::*;
696696
/// #[derive(Component, PartialEq)]
697-
/// struct Name(String);
697+
/// struct Life(u64);
698698
///
699699
/// let world = World::new();
700-
/// let entity_1 = world.spawn().insert(Name("Alice")).id();
701-
/// let entity_2 = world.spawn().insert(Name("Bob")).id();
700+
/// let entity_1 = world.spawn().insert(Life(1)).id();
701+
/// let entity_2 = world.spawn().insert(Life(2)).id();
702702
///
703-
/// let name_query = world.query::<Name>();
704-
/// let (mut entity_1_name, mut entity_2_name) = name_query.get_pair_mut(entity_1, entity_2);
703+
/// let life_query = world.query::<&mut Life>();
704+
/// let (mut entity_1_life, mut entity_2_life) = life_query.get_pair_mut(entity_1, entity_2);
705705
///
706-
/// *entity_1_name = Name("Alan");
707-
/// *entity_2_name = Name("Brigitte");
706+
/// *entity_1_life = Life(0);
707+
/// *entity_2_life = Life(100);
708708
///
709-
/// asserteq!(entity_1_name, Name("Alan"));
710-
/// asserteq!(entity_2_name, Name("Brigitte"));
709+
/// assert_eq!(entity_1_life, Life(0));
710+
/// assert_eq!(entity_2_life, Life(100));
711711
#[inline]
712712
pub fn get_pair_mut(
713713
&'s self,
@@ -744,7 +744,7 @@ where
744744
/// let entity_1 = world.spawn().insert(A(1)).id();
745745
/// let entity_2 = world.spawn().insert(A(2)).id();
746746
///
747-
/// let a_query = world.query::<A>();
747+
/// let a_query = world.query::<&A>();
748748
/// let a_iterator = a_query.get_multiple([entity_1, entity_2]);
749749
/// assert_eq!(a_iterator.next().unwrap(), A(1));
750750
/// assert_eq!(a_iterator.next().unwrap(), A(2));
@@ -776,15 +776,16 @@ where
776776
/// # Example
777777
/// ```rust
778778
/// # use bevy_ecs::prelude::*;
779+
/// use std::collections::BTreeSet;
779780
/// #[derive(Component, PartialEq)]
780-
/// struct Name(String);
781+
/// struct A(u64);
781782
///
782783
/// let world = World::new();
783784
/// let entity_1 = world.spawn().insert(A(1)).id();
784785
/// let entity_2 = world.spawn().insert(A(2)).id();
785786
/// let entity_3 = world.spawn().insert(A(3)).id();
786787
///
787-
/// let a_query = world.query::<A>();
788+
/// let a_query = world.query::<&mut A>();
788789
/// let a_iterator = a_query.get_multiple_mut(BTreeSet::from_iter([entity_1, entity_3]));
789790
/// let mut a_1 = a_iterator.next().unwrap();
790791
/// let mut a_3 = a_iterator.next().unwrap();

0 commit comments

Comments
 (0)