Skip to content

Commit f09c3a1

Browse files
authored
doc improvement for StateTransition (#19597)
Fixes #19594 The exact problem is described in that issue. I improved the docs to guide anyone who has the the same issue I had. I kept myself minimal, since the problem is relatively niche, hopefully it will be enough if anyone else has that problem
1 parent 4865c53 commit f09c3a1

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

crates/bevy_state/src/state/transitions.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,8 @@ pub struct OnTransition<S: States> {
5050
/// }
5151
/// ```
5252
///
53+
/// This schedule is split up into four phases, as described in [`StateTransitionSteps`].
54+
///
5355
/// [`PreStartup`]: https://docs.rs/bevy/latest/bevy/prelude/struct.PreStartup.html
5456
/// [`PreUpdate`]: https://docs.rs/bevy/latest/bevy/prelude/struct.PreUpdate.html
5557
#[derive(ScheduleLabel, Clone, Debug, PartialEq, Eq, Hash, Default)]

0 commit comments

Comments
 (0)