docs: correct example in MissedTickBehavior::Burst #4713
Merged
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.
Motivation
Hi there! While looking at the docs for MissedTickBehavior, I noticed that the comments in the code example have a very small error.
The code example forgets that the first
interval.tick()
resolves immediately after creation. So if you print out all of the elapsed times after each tick, you'll see that they all resolve immediately.Here's a playground link that shows the issue. If you run this code then you'll see the following output:
However, if you uncomment line 11, which has the extra
interval.tick().await;
that this PR proposes, then the output changes to what would be expected in the docs:Solution
This PR fixes the issue by just adding one more line with
interval.tick().await
at the beginning of the example, before the long task.