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

Suggestion: More documentation on SysError. #47

Open
jordanmack opened this issue May 10, 2023 · 0 comments
Open

Suggestion: More documentation on SysError. #47

jordanmack opened this issue May 10, 2023 · 0 comments

Comments

@jordanmack
Copy link

It would be very beneficial if these error messages had more detail in the documentation. As it is right now, there is not enough detail to give any meaningful hints to the developer on how to fix the problem.

https://github.com/nervosnetwork/ckb-std/blob/master/src/error.rs#L3-L14
https://nervosnetwork.github.io/ckb-std/riscv64imac-unknown-none-elf/doc/ckb_std/error/enum.SysError.html

An example of this is SysError::ItemMissing, which was encountered today by phroi, the developer working on iCKB. He received this error while sending a transaction. He was unable to find the proper documentation for the error. After several hours he figured out it was due to the header deps not being added to the transaction properly.

A helpful error description for each of these would explain it enough that a developer should be able to make a reasonable determination of what could be tried next.

  • Where is this error generated from?
  • What does the error mean?
  • What are common developer mistakes that could lead to this error?
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant