Improve document for App::update()#24754
Open
TheCGDF wants to merge 2 commits into
Open
Conversation
Contributor
|
Welcome, new contributor! Please make sure you've read our contributing guide, as well as our policy regarding AI usage, and we look forward to reviewing your pull request shortly ✨ |
There was a problem hiding this comment.
Pull request overview
This PR improves the App::update() API documentation in bevy_app by explaining the common manual-driving pattern where callers should check for an AppExit after running an update tick.
Changes:
- Adds a note that
should_exit()is typically checked afterupdate()when driving the app manually. - Adds an example showing how to call
update()and then handleAppExitviashould_exit().
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
163
to
+166
| /// Runs the default schedules of all sub-apps (starting with the "main" app) once. | ||
| /// | ||
| /// [`should_exit()`](App::should_exit) should be called after every [`update()`](App::update). | ||
| /// |
| /// | ||
| /// # Examples | ||
| /// | ||
| /// ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Objective
App::update().update()returnResult<>orVec<Error>#24568Solution
should_exit()should be called afterupdate(), with example code.