Skip to content

Conversation

@andrewhickman
Copy link
Contributor

@andrewhickman andrewhickman commented Oct 21, 2025

Objective

Currently the docs for SpawnScene link to the Main schedule, but those docs don't mention when it runs.

Solution

Updates docs to include this information, based on the schedule ordering defined here:

Update.intern(),
SpawnScene.intern(),
PostUpdate.intern(),

Copy link
Member

@alice-i-cecile alice-i-cecile left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

@alice-i-cecile alice-i-cecile added C-Docs An addition or correction to our documentation A-Scenes Serialized ECS data stored on the disk A-App Bevy apps and plugins S-Needs-Review Needs reviewer attention (from anyone!) to move forward labels Oct 21, 2025
@andrewhickman
Copy link
Contributor Author

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 Main docs from other crates, which are using direct links to docs.rs. Maybe it would make sense to follow that pattern, although we then wouldn't get an "unresolved link" error from rustdoc if it were moved to somewhere else like bevy_scene in future.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-App Bevy apps and plugins A-Scenes Serialized ECS data stored on the disk C-Docs An addition or correction to our documentation S-Needs-Review Needs reviewer attention (from anyone!) to move forward

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants