rust-lang / rust-lang/reference
Document async block types
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 1.6k
- Forks
- 607
- PR merge metrics
- PR metrics pending
Description
The section Types lists most kinds of types that can exist in a Rust program, but it does not list the types introduced by async {} and async fn. These types should be documented, since like closure types, they have nontrivial properties such as which traits they implement.
It's also unclear (at least to me) what they should be called, formally and generally — async block types? generated Future types? coroutine types? — and having that terminology nailed down would help teach Rust by avoiding inconsistent or ambiguous terminology.
@rustbot label A-async "New Content"
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 with the Reference's Types section linked in the issue and compare its treatment of closure types with async blocks and async fn. Establish consistent terminology for the introduced types, then document their relevant properties, including trait implementations; the Types section should clearly cover both async forms.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100