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

Adds doc note that Timer and Stopwatch must be progressed manually #13441

Merged
merged 3 commits into from
May 20, 2024
Merged

Adds doc note that Timer and Stopwatch must be progressed manually #13441

merged 3 commits into from
May 20, 2024

Conversation

spooky-th-ghost
Copy link
Contributor

@spooky-th-ghost spooky-th-ghost commented May 20, 2024 •
edited

Objective

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

mweatherley
mweatherley approved these changes May 20, 2024
View reviewed changes
crates/bevy_time/src/stopwatch.rs Outdated Show resolved Hide resolved
crates/bevy_time/src/timer.rs Outdated Show resolved Hide resolved
@mockersf @mweatherley
Apply suggestions from code review
0bd4f06 
Co-authored-by: Matty <weatherleymatthew@gmail.com>
@mockersf mockersf enabled auto-merge May 20, 2024 19:37
@mockersf mockersf added C-Docs An addition or correction to our documentation S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it A-Time Involves time keeping and reporting labels May 20, 2024
@mockersf mockersf added this pull request to the merge queue May 20, 2024
Merged via the queue into bevyengine:main with commit 612e77e May 20, 2024
30 checks passed
@spooky-th-ghost spooky-th-ghost deleted the timer-stopwatch-docs branch May 20, 2024 22:38
salvadorcarvalhinho pushed a commit to salvadorcarvalhinho/bevy that referenced this pull request 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
Reviewers

@mweatherley mweatherley mweatherley approved these changes

@mockersf mockersf mockersf approved these changes

Assignees
No one assigned
Labels
A-Time Involves time keeping and reporting C-Docs An addition or correction to our documentation S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Timer and Stopwatch should be explicit about the need to manually tick them
3 participants
@spooky-th-ghost @mweatherley @mockersf