rust-lang / rust-lang/rustc-dev-guide
Incorporate guidance on long error messages
Open
Nobody has claimed this yet.
A-diagnostics
C-enhancement
E-help-wanted
E-medium
T-compiler
WG-diagnostics
- Dominant language
- HTML
- Stars
- 1.9k
- Forks
- 613
- Avg merge
- 17h 24m
- Merged PRs (30d)
- 39
Description
We have
https://rust-lang.github.io/rfcs/1567-long-error-codes-explanation-normalization.html
which has some conventions for long error codes. This should be in the rustc-guide.
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 reading RFC 1567, linked in the issue, to identify its conventions for long error codes. Then locate the relevant error-message section in the rustc-guide and document that guidance there. Done means the guide explains the applicable long-error-code conventions and links or reflects the RFC accurately.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- compilers, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100