Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Prompt for reporting unhelpful error messages and contributing to improvements #3711

Open
turbolent opened this issue Dec 10, 2024 · 2 comments

Comments

@turbolent
Copy link
Member

Issue to be solved

The current error messages are sometimes not helpful enough and could be improved. See e.g. #294 and #2050

Suggested Solution

When reporting error messages, prompt the developer to report unhelpful error messages and to contribute improvements.

This could be limited to off-chain use-cases, i.e. in developer tooling.

For example:

Was this error unhelpful? Do you maybe even have a suggestion for how it could be improved?
Please report it in this issue: <LINK>
@bluesign
Copy link
Contributor

bluesign commented Dec 11, 2024

can we make some section in http://cadence-lang.org for errors, and explain each error there maybe?

something like ( from original issue references ) https://typescript.tv/errors/#ts1006 ( not sure if we have unique number for error messages but I think error type can also work )

we can link to the page in error message, and people can improve the description there also with PR

@turbolent
Copy link
Member Author

Yeah, definitely a good idea. Rust does this too, e.g. https://doc.rust-lang.org/error_codes/E0015.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants