Doc string for SQISW contains typos (unitary is incorrect)
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 68/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- python
- Domain
- documentation
Research direction
Start in pyquil/simulation/matrices.py around the SQISW doc string linked in the issue, then inspect the generated API documentation to compare formatting. Correct the SQISW formatting and missing third-row elements, and fix “conditonal” in the FSIM and PHASEDFSIM doc strings. Done means the source and rendered documentation show the corrected descriptions.
Written by the indexing model from the issue text.
Description
Pre-Report Checklist
- [ X] I am running the latest versions of pyQuil and the Forest SDK
- [ X] I checked to make sure that this bug has not already been reported
Issue Description
The doc string for the SQISW gate in pyquil.simulation.matrices has some issues:
- the formatting is not correct,
- elements are missing from the 3rd row of the unitary.
There is also a typo in the word "conditonal" in the phrase "XX+YY interaction with conditonal phase on |11>" which appears in the doc string for both the FSIM and PHASEDFSIM gates.
How to Reproduce
Check the source code or the documentation artifacts. The latter is the easiest way of seeing the problems (as the documentation is nicely formatted).
- Dominant language
- Python
- Stars
- 1.5k
- Forks
- 358
- Avg merge
- 1d 58m
- Merged PRs (30d)
- 4
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.
More from rigetti/pyquil
-
documentation :memo:
Difficulty 1/5 Under an hour Newbie friendliness 82/100
-
bug :bug: documentation :memo: v3
Difficulty 1/5 Under an hour Newbie friendliness 70/100
-
bug :bug:
Difficulty 1/5 Under an hour Newbie friendliness 65/100
-
devops :rocket:
Difficulty 5/5 Over a week Newbie friendliness 45/100
-
bug :bug:
Difficulty 3/5 1-2 days Newbie friendliness 70/100
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100