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

quantum_info "on this page" does not show methods properly #395

Closed
1 of 5 tasks
pandasa123 opened this issue Nov 22, 2023 · 2 comments
Closed
1 of 5 tasks

quantum_info "on this page" does not show methods properly #395

pandasa123 opened this issue Nov 22, 2023 · 2 comments

Comments

@pandasa123
Copy link
Collaborator

pandasa123 commented Nov 22, 2023

URL to the relevant documentation

If we look at the "on this page" sidebar for quantum_info page, I see References and Examples, instead of the actual methods like hellinger_fidelity

Select all that apply

  • typo
  • code bug
  • out-of-date content
  • broken link
  • other

Describe the fix.

  1. Go to https://docs.quantum-computing.ibm.com/api/qiskit/quantum_info#references-1
  2. Try finding hellinger_fidelity
  3. Look at the right side "on this page"
@woodsp-ibm
Copy link
Member

I think this is likely the same problem described by this. I was just looking at QuantumCircuit docs https://docs.quantum.ibm.com/api/qiskit/qiskit.circuit.QuantumCircuit as I wanted to provide a link in an answer to compose. So I was looking in the right-hand sidebar for compose method and got confused when starting to look down the list under Methods that I come across an Examples heading at the same level.

image

I realized after a bit that what was under it was still the methods though. Looking down the list there are other headings that seem to break up the list like Notes and Example These seem to be inline examples and notes for the methods, where the presentation in the sidebar makes it appear not the case.

I searched to see if the issue I was seeing was already noted. I think this is probably the same thing or at least related. The issue here describes the method being looked for as not found. In my case the method, compose, I was looking for was there it was just these "extra" headings that added confusion.

@Eric-Arellano
Copy link
Collaborator

This has now been fixed by @frankharkins in #683. The change is deployed for current docs and @arnaucasau will regenerate all the historical API docs with the change. Thank you, Frank, and thank you both for the feedback!

quantum_info:

Screenshot 2024-01-26 at 9 33 47 AM

QuantumCircuit:

Screenshot 2024-01-26 at 9 34 35 AM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

6 participants