rust-lang / rust-lang/reference
Document what `mut` does in identifier patterns
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 1.6k
- Forks
- 607
- PR merge metrics
- PR metrics pending
Description
The syntax is documented in the reference: https://doc.rust-lang.org/stable/reference/patterns.html#identifier-pattern, but afaict not the meaning.
Impact
Experienced users can still get tripped up by things like: https://stackoverflow.com/questions/69845063/why-does-a-level-of-indirection-allow-omitting-mut (I'm a Rust n00b, but posted the question for a Rust-experienced colleague).
How to fix:
If someone has a definition of mut handy, I can make PRs to update relevant parts of the docs. Apologies if mut is already defined and I missed 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 with the Rust Reference's identifier-pattern section linked in the issue and compare its existing syntax description with the behavior of mut. Use the linked Stack Overflow example to identify the missing explanation, then update the relevant reference documentation so the meaning and indirection behavior are clear.
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
- 42/100