Skip to content
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

Timer and Stopwatch should be explicit about the need to manually tick them #13421

Closed
alice-i-cecile opened this issue May 18, 2024 · 0 comments · Fixed by #13441
Closed

Timer and Stopwatch should be explicit about the need to manually tick them #13421

alice-i-cecile opened this issue May 18, 2024 · 0 comments · Fixed by #13441
Labels
A-Time Involves time keeping and reporting 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! X-Uncontroversial This work is generally agreed upon

Comments

@alice-i-cecile
Copy link
Member

How can Bevy's documentation be improved?

Timer and Stopwatch must be manually ticked by users in systems. This is critical (and unintuitive) fact, which should be prominently mentioned.

Related to #13420.
@alice-i-cecile alice-i-cecile added 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! A-Time Involves time keeping and reporting X-Uncontroversial This work is generally agreed upon labels May 18, 2024
@spooky-th-ghost spooky-th-ghost mentioned this issue May 20, 2024
Merged
github-merge-queue bot pushed a commit that referenced this issue May 20, 2024
@spooky-th-ghost @mockersf @mweatherley
Adds doc note that Timer and Stopwatch must be progressed manually (#…
612e77e 
…13441)

# Objective
- Fix #13421 

## Solution

- Add an explicit note at the root of each struct that they must be
ticked manually

## Testing

- Generated the docs and the changes look good
---

---------

Co-authored-by: François Mockers <francois.mockers@vleue.com>
Co-authored-by: Matty <weatherleymatthew@gmail.com>
salvadorcarvalhinho pushed a commit to salvadorcarvalhinho/bevy that referenced this issue May 25, 2024
@spooky-th-ghost @mockersf
@mweatherley @salvadorcarvalhinho
Adds doc note that Timer and Stopwatch must be progressed manually (b…
65d248d 
…evyengine#13441)

# Objective
- Fix bevyengine#13421 

## Solution

- Add an explicit note at the root of each struct that they must be
ticked manually

## Testing

- Generated the docs and the changes look good
---

---------

Co-authored-by: François Mockers <francois.mockers@vleue.com>
Co-authored-by: Matty <weatherleymatthew@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-Time Involves time keeping and reporting 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! X-Uncontroversial This work is generally agreed upon
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Adds doc note that Timer and Stopwatch must be progressed manually spooky-th-ghost/bevy
1 participant
@alice-i-cecile