Document single_threaded_async feature
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 72
- Forks
- 16
- PR merge metrics
- No merged PRs in 30d
Description
Before proceeding, is there an existing issue or discussion for this?
- I have done a search for similar issues and discussions.
Description
Until web assembly can support threading, users that target web assembly will need to activate the single_threaded_async feature.
I believe we shouldn't automatically turn on the single_threaded_async behavior for wasm targets because
- web assembly will probably support multi-threading before very long
- users may have reasons for wanting the single-threaded execution even without wasm
so we'll just keep it as its own feature, but we should provide clear documentation on when, how, and why to use it.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the documentation for the single_threaded_async feature and the guidance for wasm targets. Explain when, how, and why users should enable the feature, including that it is not automatically enabled for wasm or other targets. Done means users can make an informed choice from the documentation alone.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100