rust-bitcoin / rust-bitcoin/rust-bitcoin
Document error returns
Open
Nobody has claimed this yet.
1.0
- Dominant language
- Rust
- Stars
- 2.7k
- Forks
- 1k
- Avg merge
- 4d 1h
- Merged PRs (30d)
- 88
Description
Running cargo clippy -- -Dclippy::missing_errors_doc gives a bunch of warnings. We should consider documenting all error returns.
Contributor guide
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 running cargo clippy -- -Dclippy::missing_errors_doc and review the warnings across the library. Identify the affected public error-returning items and document their error returns; done means the missing-errors-doc warnings are addressed.
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
- Needs clarification
- Newbie friendliness
- 32/100