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.

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

docs: clarify the role between use_task and use_thread #783

Merged
merged 1 commit into from
Sep 13, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions solara/website/pages/documentation/api/hooks/use_thread.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,3 +56,9 @@ graph TD;
RUNNING-- "work finished" -->FINISHED
RUNNING-- "cancel()" -->CANCELLED
```

## Future deprecation

Note that [`use_task`](/https://solara.dev/documentation/components/lab/use_task) is an alternative to `use_thread` that will most likely
replace `use_thread` in the future. Compared to `use_thread`, `use_task` has no intrusive cancel, which turned out to be too large of
a performance overhead to be useful. Also, `use_task` can run async functions, which is not possible with `use_thread`.
Loading