Include SpawnScene in docs for Main schedule#21624
Conversation
alice-i-cecile
left a comment
There was a problem hiding this comment.
A bit iffy on this: it's added by a dependency, so it won't always exist and the doc link will be broken.
Can we instead add docs to SpawnScene clarifying exactly when it runs?
|
I've added a note to SpawnScene. I've left the link in Main for now, because currently SpawnScene is defined in the same crate as Main, so I think the link will always be valid. Happy to remove it if you still think that's best. There are already several schedules in the |
alice-i-cecile
left a comment
There was a problem hiding this comment.
Ah, TIL. That should probably not be defined in this crate 😔 But, a problem for another PR!
Objective
Currently the docs for
SpawnScenelink to theMainschedule, but those docs don't mention when it runs.Solution
Updates docs to include this information, based on the schedule ordering defined here:
bevy/crates/bevy_app/src/main_schedule.rs
Lines 222 to 224 in 78d940c