rust-lang / rust-lang/rustc_public
Improve code documentation
Open
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 125
- Forks
- 19
- PR merge metrics
- No merged PRs in 30d
Description
StableMIR definitions could use some comments.
I don't know what is the best way to move forward to avoid duplicating rustc's documentation plus adding more comments.
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 locating the StableMIR definitions and reviewing how rustc documents the corresponding definitions. Determine which comments are missing and agree on an approach that avoids duplicating rustc's documentation; done means the relevant definitions have useful comments and the documentation strategy is consistent.
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
- Needs clarification
- Newbie friendliness
- 25/100