-
-
Notifications
You must be signed in to change notification settings - Fork 3.7k
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.
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
Add missing documentation to bevy_time
#9428
Conversation
Progress towards #3492 |
Not introduced by this PR but can be fixed by it, wrong backticks in https://docs.rs/bevy/0.11.0/bevy/time/fixed_timestep/struct.FixedTime.html#method.expend: (the doc of |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The doc on this page is great: https://docs.rs/bevy_time/0.11.0/bevy_time/fixed_timestep/index.html but FixedTime and run_fixed_update_schedule don't link back to it. Since FixedUpdate links to run_fixed_update_schedule
, I think it would be great to link back to the central doc on fixed time, people (me at least) don't always think to check module documentation.
Co-authored-by: Sélène Amanita <134181069+Selene-Amanita@users.noreply.github.com>
Thank you for the review. I believe I have addressed your points. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Besides a small typo looks good to me!
Co-authored-by: Sélène Amanita <134181069+Selene-Amanita@users.noreply.github.com>
To help you with missing docs, you can add |
@GuillaumeGomez a warn equivalent was added in |
Nice! There is also |
Objective
bevy_time
.