oxidecomputer / oxidecomputer/hubtools
`enum Error` should use `#[source]` annotations and not print source error in `Display`
Open
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 2
- Forks
- 5
- Avg merge
- 49m
- Merged PRs (30d)
- 1
Description
https://github.com/oxidecomputer/slog-error-chain#aside-embedding-source-error-strings for why printing in Display is bad
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 locating the enum Error referenced in the issue and read the linked slog-error-chain explanation about embedding source error strings. Update the error definitions so source errors use #[source] annotations and are not included in Display; completion means the resulting display output omits the source error text.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- tooling
- Issue type
- Refactor
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100