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.

Sign up for GitHub

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

Jump to bottom

All SnarkyJS errors should be very clear and include references to learn more #130

Open
bkase opened this issue Apr 27, 2022 · 1 comment
Open

All SnarkyJS errors should be very clear and include references to learn more #130

bkase opened this issue Apr 27, 2022 · 1 comment
Labels
error-messages Issues about making error messages better move-to-js Refactor parts of the OCaml portion to JS

Comments

@bkase
Copy link
Member

bkase commented Apr 27, 2022

Error messages typically use jargon that beginners may be unfamiliar with. All errors should be sufficiently detailed to explain exactly what is going on to someone with no context -- this may include a reference link to documentation to learn more.

Draw inspiration from Elm/Rust errors messages
@bkase
Copy link
Member Author

bkase commented Apr 27, 2022

I think this entails creating our own custom Error wrapper so formatting can be consistent as well

@bkase bkase mentioned this issue Apr 27, 2022
Merged
@mitschabaude mitschabaude added the move-to-js Refactor parts of the OCaml portion to JS label Jan 4, 2023
@bkase bkase added the error-messages Issues about making error messages better label Jan 5, 2023
@dfstio dfstio mentioned this issue Nov 3, 2023
Open
gabrielbosio pushed a commit to lambdaclass/o1js that referenced this issue Nov 17, 2023
@dannywillems
Merge pull request o1-labs#130 from o1-labs/feature/custom-gates-develop
f409a07 
[develop] Support custom gates in pickles (part 1)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
error-messages Issues about making error messages better move-to-js Refactor parts of the OCaml portion to JS
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@bkase @mitschabaude