rust-lang / rust-lang/reference
Consider improving wording about generic functions and traits.
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 1.6k
- Forks
- 607
- PR merge metrics
- PR metrics pending
Description
In functions.html
A generic function allows one or more parameterized types to appear in its signature. Each type parameter ...
In traits.html
Type parameters can be specified for a trait to make it generic.
These should be called generic parameters instead. Maybe just move and reference these contents to the Generic parameters chapter.
In generics.html
References, raw pointers, arrays, slices, tuples, and function pointers have lifetime or type parameters as well, but are not referred to with path syntax.
The sentences surrounding this paragraph is talking about items. And it's not really clear what this paragraph actually means...
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 reading the relevant sections in functions.html, traits.html, and generics.html, then compare their terminology with the Generic parameters chapter. Review the surrounding text in generics.html to clarify what the paragraph about references, raw pointers, arrays, slices, tuples, and function pointers means. Done means the wording consistently refers to generic parameters and the explanation is clear in context.
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