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

Documentation: Impove CASE_DEFAULT documentation #10458

Closed
kevinsung opened this issue Jul 20, 2023 · 2 comments · Fixed by #10484
Closed

Documentation: Impove CASE_DEFAULT documentation #10458

kevinsung opened this issue Jul 20, 2023 · 2 comments · Fixed by #10484
Assignees
Labels
documentation Something is not clear or an error documentation type: feature request New feature or request
Milestone

Comments

@kevinsung
Copy link
Contributor

What should we add?

From https://qiskit.org/documentation/stubs/qiskit.circuit.SwitchCaseOp.html:

The special value CASE_DEFAULT can be used to represent a default condition.

But it doesn't explain how to import CASE_DEFAULT and there is no hyperlink.

@kevinsung kevinsung added the type: feature request New feature or request label Jul 20, 2023
@jakelishman jakelishman self-assigned this Jul 20, 2023
@jakelishman jakelishman added the documentation Something is not clear or an error documentation label Jul 20, 2023
@jakelishman
Copy link
Member

jakelishman commented Jul 20, 2023

Yeah, it's meant to hyperlink to an entry right underneath this table of the control-flow ops, but I must have screwed up the Sphinx syntax, because that entry hasn't actually been build, so there's nothing to link to.

I'll fix it tomorrow, because I don't want to put up a new PR right now while we're in a CI concurrency crunch for the 0.25.0rc1 release today (or early tomorrow if we can't get through CI).

@jakelishman
Copy link
Member

I've made #10484 that hopefully should make a bunch of improvements here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Something is not clear or an error documentation type: feature request New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants