Open
Description
How can Bevy's documentation be improved?
https://bevyengine.org/examples/2d-rendering/2d-viewport-to-world/
This example adds an input handling system like so: .add_systems(FixedUpdate, controls)
.
It uses the FixedUpdate
schedule for this. However, the documentation for the Update
schedule suggests that it should be used for input handling functions instead. Furthermore, the FixedUpdate
documentation links to Update
for "examples of systems that should not use this schedule," so this might cause some confusion.
I'm assuming the API documentation is correct but I don't know whether the example is. I suggest one of these changes:
- If the example's choice of schedule for this system is indeed the preferred option, it should explain why it chooses to deviate from the recommended usage of the schedules per the API docs in a code comment.
- If the example's choice of schedule for this system is incorrect or inconsequential, it should follow the recommendations of the API docs for consistency.