Skip to content

Commit 17f04e8

Browse files
committed
update more doctests
1 parent 6b527b3 commit 17f04e8

File tree

2 files changed

+36
-18
lines changed

2 files changed

+36
-18
lines changed

crates/bevy_ecs/src/schedule/mod.rs

Lines changed: 31 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,10 @@ impl Schedule {
106106
/// # use bevy_ecs::prelude::*;
107107
/// #
108108
/// # let mut schedule = Schedule::default();
109-
/// schedule.add_stage("my_stage", SystemStage::parallel());
109+
/// // Define a new, private label for the stage.
110+
/// stage_label!(MyStage);
111+
/// // Add a stage with that label to the schedule.
112+
/// schedule.add_stage(MyStage, SystemStage::parallel());
110113
/// ```
111114
pub fn add_stage<S: Stage>(&mut self, label: impl StageLabel, stage: S) -> &mut Self {
112115
let label = label.as_label();
@@ -124,8 +127,12 @@ impl Schedule {
124127
/// # use bevy_ecs::prelude::*;
125128
/// #
126129
/// # let mut schedule = Schedule::default();
127-
/// # schedule.add_stage("target_stage", SystemStage::parallel());
128-
/// schedule.add_stage_after("target_stage", "my_stage", SystemStage::parallel());
130+
/// # stage_label!(TargetStage);
131+
/// # schedule.add_stage(TargetStage, SystemStage::parallel());
132+
/// // Define a new, private label for the stage.
133+
/// stage_label!(MyStage);
134+
/// // Add a stage with that label to the schedule.
135+
/// schedule.add_stage_after(TargetStage, MyStage, SystemStage::parallel());
129136
/// ```
130137
pub fn add_stage_after<S: Stage>(
131138
&mut self,
@@ -157,9 +164,13 @@ impl Schedule {
157164
/// # use bevy_ecs::prelude::*;
158165
/// #
159166
/// # let mut schedule = Schedule::default();
160-
/// # schedule.add_stage("target_stage", SystemStage::parallel());
167+
/// # stage_label!(TargetStage);
168+
/// # schedule.add_stage(TargetStage, SystemStage::parallel());
161169
/// #
162-
/// schedule.add_stage_before("target_stage", "my_stage", SystemStage::parallel());
170+
/// // Define a new, private label for the stage.
171+
/// stage_label!(MyStage);
172+
/// // Add a stage with that label to the schedule.
173+
/// schedule.add_stage_before(TargetStage, MyStage, SystemStage::parallel());
163174
/// ```
164175
pub fn add_stage_before<S: Stage>(
165176
&mut self,
@@ -192,9 +203,10 @@ impl Schedule {
192203
/// #
193204
/// # fn my_system() {}
194205
/// # let mut schedule = Schedule::default();
195-
/// # schedule.add_stage("my_stage", SystemStage::parallel());
206+
/// # stage_label!(MyStage);
207+
/// # schedule.add_stage(MyStage, SystemStage::parallel());
196208
/// #
197-
/// schedule.add_system_to_stage("my_stage", my_system);
209+
/// schedule.add_system_to_stage(MyStage, my_system);
198210
/// ```
199211
pub fn add_system_to_stage<Params>(
200212
&mut self,
@@ -227,10 +239,11 @@ impl Schedule {
227239
/// #
228240
/// # fn my_system() {}
229241
/// # let mut schedule = Schedule::default();
230-
/// # schedule.add_stage("my_stage", SystemStage::parallel());
242+
/// # stage_label!(MyStage);
243+
/// # schedule.add_stage(MyStage, SystemStage::parallel());
231244
/// #
232245
/// schedule.add_system_set_to_stage(
233-
/// "my_stage",
246+
/// MyStage,
234247
/// SystemSet::new()
235248
/// .with_system(system_a)
236249
/// .with_system(system_b)
@@ -264,9 +277,10 @@ impl Schedule {
264277
/// # use bevy_ecs::prelude::*;
265278
/// #
266279
/// # let mut schedule = Schedule::default();
267-
/// # schedule.add_stage("my_stage", SystemStage::parallel());
280+
/// # stage_label!(MyStage);
281+
/// # schedule.add_stage(MyStage, SystemStage::parallel());
268282
/// #
269-
/// schedule.stage("my_stage", |stage: &mut SystemStage| {
283+
/// schedule.stage(MyStage, |stage: &mut SystemStage| {
270284
/// stage.add_system(my_system)
271285
/// });
272286
/// #
@@ -302,9 +316,10 @@ impl Schedule {
302316
/// #
303317
/// # fn my_system() {}
304318
/// # let mut schedule = Schedule::default();
305-
/// # schedule.add_stage("my_stage", SystemStage::parallel());
319+
/// # stage_label!(MyStage);
320+
/// # schedule.add_stage(MyStage, SystemStage::parallel());
306321
/// #
307-
/// let stage = schedule.get_stage::<SystemStage>(&"my_stage").unwrap();
322+
/// let stage = schedule.get_stage::<SystemStage>(&MyStage).unwrap();
308323
/// ```
309324
pub fn get_stage<T: Stage>(&self, label: &dyn StageLabel) -> Option<&T> {
310325
self.stages
@@ -323,9 +338,10 @@ impl Schedule {
323338
/// #
324339
/// # fn my_system() {}
325340
/// # let mut schedule = Schedule::default();
326-
/// # schedule.add_stage("my_stage", SystemStage::parallel());
341+
/// # stage_label!(MyStage);
342+
/// # schedule.add_stage(MyStage, SystemStage::parallel());
327343
/// #
328-
/// let stage = schedule.get_stage_mut::<SystemStage>(&"my_stage").unwrap();
344+
/// let stage = schedule.get_stage_mut::<SystemStage>(&MyStage).unwrap();
329345
/// ```
330346
pub fn get_stage_mut<T: Stage>(&mut self, label: &dyn StageLabel) -> Option<&mut T> {
331347
self.stages

crates/bevy_ecs/src/world/mod.rs

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,9 +55,11 @@ pub use identifier::WorldId;
5555
/// 2. Fetch the resource from a system, using [`Res`](crate::system::Res) or [`ResMut`](crate::system::ResMut).
5656
///
5757
/// ```
58+
/// # stage_label!(Update);
59+
/// # system_label!(first);
5860
/// # let mut world = World::default();
5961
/// # let mut schedule = Schedule::default();
60-
/// # schedule.add_stage("update", SystemStage::parallel());
62+
/// # schedule.add_stage(Update, SystemStage::parallel());
6163
/// # use bevy_ecs::prelude::*;
6264
/// #
6365
/// struct MyResource { value: u32 }
@@ -74,8 +76,8 @@ pub use identifier::WorldId;
7476
/// assert_eq!(resource.value, 0);
7577
/// }
7678
/// #
77-
/// # schedule.add_system_to_stage("update", read_resource_system.label("first"));
78-
/// # schedule.add_system_to_stage("update", write_resource_system.after("first"));
79+
/// # schedule.add_system_to_stage(Update, read_resource_system.label(first));
80+
/// # schedule.add_system_to_stage(Update, write_resource_system.after(first));
7981
/// # schedule.run_once(&mut world);
8082
/// ```
8183
pub struct World {

0 commit comments

Comments
 (0)