Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix documentation of SwitchCaseOp #10484

Merged
merged 1 commit into from
Jul 24, 2023

Conversation

jakelishman
Copy link
Member

Summary

The class page for the SwitchCaseOp had some broken hyperlinks, and the documentation of the switch CASE_DEFAULT object was broken. This fixes both, and adds some more explicit examples of usage of the CASE_DEFAULT object, with some overlap of what was already in QuantumCircuit.switch.

Details and comments

Fix #10458

The class page for the `SwitchCaseOp` had some broken hyperlinks, and
the documentation of the switch `CASE_DEFAULT` object was broken.  This
fixes both, and adds some more explicit examples of usage of the
`CASE_DEFAULT` object, with some overlap of what was already in
`QuantumCircuit.switch`.
@jakelishman jakelishman added documentation Something is not clear or an error documentation stable backport potential The bug might be minimal and/or import enough to be port to stable Changelog: None Do not include in changelog labels Jul 24, 2023
@jakelishman jakelishman requested a review from a team as a code owner July 24, 2023 13:04
@qiskit-bot
Copy link
Collaborator

One or more of the the following people are requested to review this:

  • @Qiskit/terra-core

@coveralls
Copy link

Pull Request Test Coverage Report for Build 5645189636

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 4 unchanged lines in 1 file lost coverage.
  • Overall coverage increased (+0.01%) to 85.924%

Files with Coverage Reduction New Missed Lines %
crates/qasm2/src/lex.rs 4 90.89%
Totals Coverage Status
Change from base Build 5644595200: 0.01%
Covered Lines: 73019
Relevant Lines: 84981

💛 - Coveralls

@mtreinish mtreinish added this to the 0.25.0 milestone Jul 24, 2023
@mtreinish mtreinish added this pull request to the merge queue Jul 24, 2023
Merged via the queue into Qiskit:main with commit 845746d Jul 24, 2023
mergify bot pushed a commit that referenced this pull request Jul 24, 2023
The class page for the `SwitchCaseOp` had some broken hyperlinks, and
the documentation of the switch `CASE_DEFAULT` object was broken.  This
fixes both, and adds some more explicit examples of usage of the
`CASE_DEFAULT` object, with some overlap of what was already in
`QuantumCircuit.switch`.

(cherry picked from commit 845746d)
@jakelishman jakelishman deleted the switch-documentation branch July 24, 2023 21:25
github-merge-queue bot pushed a commit that referenced this pull request Jul 24, 2023
The class page for the `SwitchCaseOp` had some broken hyperlinks, and
the documentation of the switch `CASE_DEFAULT` object was broken.  This
fixes both, and adds some more explicit examples of usage of the
`CASE_DEFAULT` object, with some overlap of what was already in
`QuantumCircuit.switch`.

(cherry picked from commit 845746d)

Co-authored-by: Jake Lishman <jake.lishman@ibm.com>
to24toro pushed a commit to to24toro/qiskit-terra that referenced this pull request Aug 3, 2023
The class page for the `SwitchCaseOp` had some broken hyperlinks, and
the documentation of the switch `CASE_DEFAULT` object was broken.  This
fixes both, and adds some more explicit examples of usage of the
`CASE_DEFAULT` object, with some overlap of what was already in
`QuantumCircuit.switch`.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Changelog: None Do not include in changelog documentation Something is not clear or an error documentation stable backport potential The bug might be minimal and/or import enough to be port to stable
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation: Impove CASE_DEFAULT documentation
4 participants