Skip to content

Include SpawnScene in docs for Main schedule#21624

Merged
alice-i-cecile merged 2 commits into
bevyengine:mainfrom
andrewhickman:spawn-scene-docs
Oct 25, 2025
Merged

Include SpawnScene in docs for Main schedule#21624
alice-i-cecile merged 2 commits into
bevyengine:mainfrom
andrewhickman:spawn-scene-docs

Conversation

@andrewhickman

@andrewhickman andrewhickman commented Oct 21, 2025

Copy link
Copy Markdown
Contributor

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(),

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

Copy link
Copy Markdown
Member

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 Composing and serializing ECS objects A-App Bevy apps and plugins S-Needs-Review Needs reviewer attention (from anyone!) to move forward labels Oct 21, 2025
@andrewhickman

Copy link
Copy Markdown
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.

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

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Ah, TIL. That should probably not be defined in this crate 😔 But, a problem for another PR!

@alice-i-cecile alice-i-cecile added D-Trivial Nice and easy! A great choice to get started with Bevy S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it and removed S-Needs-Review Needs reviewer attention (from anyone!) to move forward labels Oct 25, 2025
@alice-i-cecile alice-i-cecile added this pull request to the merge queue Oct 25, 2025
Merged via the queue into bevyengine:main with commit 3ca7b50 Oct 25, 2025
40 checks passed
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 Composing and serializing ECS objects C-Docs An addition or correction to our documentation D-Trivial Nice and easy! A great choice to get started with Bevy S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants