rust-lang / rust-lang/rustc-dev-guide
Define "definition", "node", and "item" more precisely in section on hir
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 1.9k
- Forks
- 613
- Avg merge
- 17h 24m
- Merged PRs (30d)
- 39
Description
In the guide on hir, the terms "definition", "node", and "item" are used without much explanation which leaves the terms vague and fuzzy. If possible, we should try to more precisely define them so that newcomers have a better picture in their head of what they refer to.
Contributor guide
No contributing guide indexed for this repository
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 HIR guide at hir.html and review how “definition,” “node,” and “item” are currently used in that section. Clarify each term in place so newcomers can distinguish what it refers to; the work is done when the section gives precise, understandable definitions without leaving these terms vague.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- compilers, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100