Fix timers.rs documentation #9290
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
The documentation for the `print_when_completed` system stated that this system would tick the `Timer` component on every entity in the scene. This was incorrect as this system only ticks the `Timer` on entities with the `PrintOnCompletionTimer` component. We suggest a modification to the documentation of this system to make it more clear.
|
Welcome, new contributor! Please make sure you've read our contributing guide and we look forward to reviewing your pull request shortly ✨ |
alice-i-cecile
approved these changes
Jul 27, 2023
alice-i-cecile
added
C-Examples
|
Thanks: that's a much better comment now. |
mockersf
approved these changes
Jul 30, 2023
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.
Objective
The documentation for the
print_when_completedsystem stated that this system would tick theTimercomponent on every entity in the scene.This was incorrect as this system only ticks the
Timeron entities with thePrintOnCompletionTimercomponent.Solution
We suggest a modification to the documentation of this system to make it more clear.