rust-lang / rust-lang/reference
Using "future" with a little `f`.
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 1.6k
- Forks
- 607
- PR merge metrics
- PR metrics pending
Description
There are a number of places that talk about a "future" with a lowercase f, but what a "future" is is never defined. It can maybe be inferred that it is an expression or type that implements std::future::Future.
I think, maybe, the solution here is to just add a glossary entry that states that explicitly, and maybe linking to it from a few places where there is no context given.
Alternatively, the places where the little f future is written, it could be written as Future with a capital F and a link. However, for some reason that seems less ideal to me.
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
Search the Rust Reference for occurrences of lowercase “future” and inspect the glossary structure. Decide whether the glossary definition should be linked from context-free uses or whether those uses should link directly to std::future::Future; done means the terminology is defined and the affected references are consistent.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100