Add error explanations for all error codes #32777
2 participants
@marti1125: I guess the first step is to find one of the listed error codes into the rust source code (github search makes it easy) and then try to get the error with rust code. From there, just follow the description of this issue and if you need help, you can always ask (here or on IRC on #rust-docs chan).
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
This is a reopening of #24407 issue. So I took back what was already there and updated it:
This is a metabug for
rustc --explainerror descriptions.All the errors in need of descriptions are listed in this spreadsheet. If you'd like to help out, comment with the bunch of errors you'd like to tackle, and list yourself as assigned on the spreadsheet!
Choosing a few errors in the same file is probably a good way to start.
How to add an error explanation
Error explanations live in:
To add a new explanation you have to delete the error from the register_diagnostics! invocation and add it to the register_long_diagnostics! invocation, along with the explanation. The format for the explanation is 80 characters per line, with a newline at the very start and end of the string.
Please refer to this RFC when you'll write your error explanation (it can also helps you to start if don't know how to write it).
Once you've added an explanation you can test it out by compiling and running stage1 as follows:
If you want to see how it renders as HTML you'll have to build the error index, which requires stage2:
You can add -j 4 to use 4 parallel make processes:
Once you're happy with the result, submit a pull request and we'll review it.
Progress
cc @steveklabnik