rust-lang / rust-lang/rust-by-example
Generics before Traits and Implementation
Open
Nobody has claimed this yet.
- Dominant language
- Handlebars
- Stars
- 8.1k
- Forks
- 1.6k
- PR merge metrics
- No merged PRs in 30d
Description
This part of the document seems to assume that Traits, which are first explored in 2 chapters later, are already known to the reader, without even some sort of introduction as to what they are meant to be or what use they serve. Same goes with "Implementation".
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 linked Generics section in Rust by Example and compare it with the later Traits and Implementation chapters. Rework the documentation order or introductions so readers encounter the needed concepts before they are used; done means the Generics section no longer assumes unexplained knowledge of Traits or Implementation.
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