rigetti / rigetti/qcs-sdk-rust

Make error types more consistent

Open
#441 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
15
Forks
4
Avg merge
1h 9m
Merged PRs (30d)
1

Description

The way we define errors vary throughout the SDK. We sometimes define error types for specific calls, other times at the module level, and other times by pulling them in from elsewhere. While each approach can have its place, it doesn't appear to have been done with a lot of intent, and sometimes the Python module has differing error shapes from it's Rust counterpart. Many of our errors repeat themselves via thiserror (e.g. ExecutionError and executable::Error). We should have an agreed upon way we define errors that is consistent and intuitive across the SDK.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by surveying the Rust and Python error definitions, including thiserror uses such as ExecutionError and executable::Error, and compare the error shapes across both SDK counterparts. The issue does not name specific files or tests. Done means an agreed, documented approach is established and the duplicated or inconsistent error definitions are addressed consistently.

Written by the indexing model from the issue text.

Assessment

Tech stack
python, rust
Domain
backend-api-design
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.