nervosnetwork / nervosnetwork/ckb-std
Suggestion: More documentation on SysError.
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 28
- Forks
- 22
- PR merge metrics
- No merged PRs in 30d
Description
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?
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 with src/error.rs#L3-L14 and compare it with the generated SysError documentation linked in the issue. Document each error's source, meaning, and common developer mistakes, including the ItemMissing example and missing header dependencies; done means developers can identify reasonable next steps from the documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100