FAQ links in error messages
Nobody has claimed this yet.
- Dominant language
- Markdown
- Stars
- 6.6k
- Forks
- 1.7k
- Avg merge
- 16h 14m
- Merged PRs (30d)
- 1
Description
Sunday Apr 01, 2012 at 02:51 GMT
For earlier discussion, see https://github.com/rust-lang/rust/issues/2092
This issue was labelled with: A-an-interesting-project, A-docs, A-frontend, I-wishlist, P-high in the Rust repository
On IRC we were discussing how, for complex errors, we ought to put a link to a FAQ in the error message. Perhaps we could even embed the rust manual and print the relevant paragraph if you use rustc --explain or something.
Some examples of errors that could benefit:
retdisallowed from within sugared closure{|| ... };required after a statement with non-unit type- etc.
This of course would also entail making such a FAQ. :)
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 the earlier discussion in issue 2092 and the examples of complex errors listed here. Investigate the proposed rustc --explain entry point and determine the scope of the FAQ or embedded manual, including which errors should link to explanations. Done means an agreed design and a defined set of explanations to implement.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- compilers, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100