Wrong docstring in `CliffordUnitary::from_images`
Open
Beginner friendly
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 64
- Forks
- 16
- Avg merge
- 1d 5h
- Merged PRs (30d)
- 5
Description
The following doc string states that images are provided in groups (first all X, then all Z):
However, the underlying Rust implementation expects them in interleaved order:
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
Compare the docstring in paulimer/bindings/python/paulimer.pyi around lines 513-519 with the implementation in paulimer/src/clifford/generic_algos.rs around lines 345-350. Update the documentation so it accurately describes the ordering expected by the implementation. Done when the docstring no longer conflicts with the Rust code.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 90/100