Add docs on error handling
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 489
- Forks
- 293
- Avg merge
- 18h 35m
- Merged PRs (30d)
- 3
Description
There isn't really any documentation on error handling.
Initially I think we can focus on improving the API docs, ie adding an example to the ModuleError::as_root_error() call to show off how to use that properly to decode errors.
Probably also would be good to add to the Transaction docs a Working with Errors section at the end which points to a complete example of working with errors or something like that.
See #1027
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 related issue #1027 and the existing API and Transaction documentation. Locate the ModuleError::as_root_error() documentation and the Transaction docs, then define the examples and a Working with Errors section described here. Done means both areas explain error handling with a complete, usable example.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100