rust-lang / rust-lang/rust-by-example
Annotation by default?
Nobody has claimed this yet.
- Dominant language
- Handlebars
- Stars
- 8.1k
- Forks
- 1.6k
- PR merge metrics
- No merged PRs in 30d
Description
On the RBE primitives page, the text says
Variables can always be type annotated. Numbers may additionally be annotated via a suffix or by default.
Merriam-Webster defines annotate "as to make or furnish critical or explanatory notes or comment."
If no note or comment is furnished, then there is no annotation.
This is admittedly a minor complaint about the doc, but it is distracting.
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
Open the RBE primitives page and locate the quoted sentence about type annotation and numeric suffixes or defaults. Review the surrounding explanation and revise the wording so it matches the terminology being used, then verify the rendered page reads clearly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100