rust-lang / rust-lang/rustc-dev-guide
Add a diagram of how rustc types relate to one another
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 1.9k
- Forks
- 613
- Avg merge
- 17h 24m
- Merged PRs (30d)
- 39
Description
Often people have specific question of a thing they want to do: 'how do I get all function calls, as well as the DefId of the called function and the callee'? This isn't something the dev-guide can tell right away, because there's too many different things you can do with the compiler, but what we could do instead is show how to convert between types. Ideally this would be a graph-like structure, where every node connects to its neighbors, and it's easy to see how to get between them.
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 by surveying the rustc-dev-guide's existing compiler documentation and the rustc types referenced by common questions such as function calls and DefId. Define the graph's scope and relationships before documenting it. Done means the guide contains an easy-to-follow diagram showing how relevant rustc types convert to one another.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- compilers, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100