rust-lang / rust-lang/rustc-dev-guide
The text of the guide should not be included as code comments
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 1.9k
- Forks
- 613
- Avg merge
- 17h 24m
- Merged PRs (30d)
- 39
Description
For instance, here https://rustc-dev-guide.rust-lang.org/compiler-debugging.html#getting-a-backtrace-for-errors we have a comment that says $ # Now, where does the error above come from? I guess we should take that out from comments and place that into regular text. There are probably more uses like that.
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 compiler-debugging guide section linked in the issue and inspect how the example comment is represented in the guide source. Search for other guide text embedded in code comments, move those passages into regular prose, and verify that the rendered examples still make sense.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100