chore: Replace tokio sleep with background executor timer#2504
Merged
Conversation
The documentation examples in skills/gpui/references/async.md contain incorrect async patterns that would panic at runtime. The correct pattern is to use GPUI's `cx.background_executor().timer()` instead of tokio's sleep functions.
Member
|
Thanks. |
This file contains hidden or 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
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.
Fix Async Patterns in GPUI Documentation
Description
This PR fixes the async spawn examples in
skills/gpui/references/async.mdthat contained incorrect patterns leading to runtime panics. The examples were using tokio's sleep functions (tokio::time::sleep) within GPUI's async context, which is incorrect. The correct pattern is to use GPUI's built-in timer functionality viacx.background_executor().timer().Problem Solved:
Benefits:
Screenshot
Break Changes
None. This is purely a documentation fix that corrects the example code.
Correct Async Pattern Example: