Link to Main schedule docs from other schedules
#10691
Merged
Conversation
This file contains 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
|
Hmm, I don't think this is a helpful place for this. IMO the better solution is good module or book-level docs on the basics of scheduling. |
alice-i-cecile
added
C-Docs
|
I agree, this is not ideal. Maybe I could replaced it with something like "see the Main schedule for more details how schedules are run", which explains what's going on quite clearly? |
rlidwka
reviewed
Nov 22, 2023
crates/bevy_app/src/main_schedule.rs
Outdated
| @@ -74,6 +74,10 @@ pub struct RunFixedUpdateLoop; | |||
| /// | |||
| /// Frequency of execution is configured by inserting `Time<Fixed>` resource, 64 Hz by default. | |||
| /// See [this example](https://github.com/bevyengine/bevy/blob/latest/examples/time/time.rs). | |||
| /// | |||
| /// Note that schedules are not run in parallel, in particular, | |||
| /// systems in the `FixedUpdate` schedule are not run in parallel with systems | |||
There was a problem hiding this comment.
"systems in the FixedUpdate schedule are all run before systems in the Update schedule"
next question people are going to ask is: "okay, what's the order of execution then?", and you can change just a single word in docs to immediately answer it
stepancheg
force-pushed
the
fixed-update-concurrency
branch
from
8a60dd6
to
0b7a4bd
Compare
|
Changed wording/links to main. |
alice-i-cecile
approved these changes
Nov 22, 2023
alice-i-cecile
removed
the
X-Controversial
rlidwka
approved these changes
Nov 22, 2023
alice-i-cecile
added
the
S-Ready-For-Final-Review
alice-i-cecile
changed the title
Main schedule docs from other schedules
rdrpenguin04
pushed a commit
to rdrpenguin04/bevy
that referenced
this pull request
Jan 9, 2024
I incorrectly assumed that moving a system from `Update` to `FixedUpdate` would simplify logic without hurting performance. But this is not the case: if there's single-threaded long computation in the `FixedUpdate`, the machine won't do anything else in parallel with it. Which might be not what users expect. So this PR adds a note. But maybe it is obvious, I don't know.
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.
I incorrectly assumed that moving a system from
UpdatetoFixedUpdatewould simplify logic without hurting performance.But this is not the case: if there's single-threaded long computation in the
FixedUpdate, the machine won't do anything else in parallel with it. Which might be not what users expect.So this PR adds a note. But maybe it is obvious, I don't know.