Skip to content

Docs for RenderSet are at least slightly inaccurate #16654

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
rparrett opened this issue Dec 5, 2024 · 0 comments
Open

Docs for RenderSet are at least slightly inaccurate #16654

rparrett opened this issue Dec 5, 2024 · 0 comments
Labels
A-Rendering Drawing game state to the screen 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-Implementation This issue is ready for an implementation PR. Go for it!

Comments

@rparrett
Copy link
Contributor

rparrett commented Dec 5, 2024 •
edited
Loading

Bevy version

0.15, main

What is wrong with the docs?

https://docs.rs/bevy/latest/bevy/render/enum.RenderSet.html#variant.PostCleanup

PostCleanup
Final cleanup occurs: all entities will be despawned.

I don't think there were other relevant changes to RenderSet / the render world schedule after #15320 or the various followup PRs.

The part about all entities being despawned should be changed to "any entities with TemporaryRenderEntity will be despawned."
@rparrett rparrett added C-Bug An unexpected or incorrect behavior S-Needs-Triage This issue needs to be labelled C-Docs An addition or correction to our documentation D-Trivial Nice and easy! A great choice to get started with Bevy A-Rendering Drawing game state to the screen and removed C-Bug An unexpected or incorrect behavior S-Needs-Triage This issue needs to be labelled labels Dec 5, 2024
@BenjaminBrienen BenjaminBrienen added the S-Ready-For-Implementation This issue is ready for an implementation PR. Go for it! label Dec 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-Rendering Drawing game state to the screen 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-Implementation This issue is ready for an implementation PR. Go for it!
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@rparrett @BenjaminBrienen