qiskit icon indicating copy to clipboard operation
qiskit copied to clipboard

BD improve some API references

Open beckykd opened this issue 1 year ago • 3 comments

@abbycross and I are going to take these in small groups for now. This issue is for these 2 APIs:

  • [ ] https://docs.quantum.ibm.com/api/qiskit/qiskit.quantum_info.Statevector
  • [ ] https://docs.quantum.ibm.com/api/qiskit/quantum_info

beckykd avatar Oct 08 '24 13:10 beckykd

I'd potentially suggest that all the standard-library gates are handled simultaneously in a single PR, so we can approximately keep the style consistent. With those, it'd also be good to think about what information should be on the gate pages and what information should be in the corresponding method documentation in QuantumCircuit.

jakelishman avatar Oct 08 '24 13:10 jakelishman

I'd potentially suggest that all the standard-library gates are handled simultaneously in a single PR, so we can approximately keep the style consistent. With those, it'd also be good to think about what information should be on the gate pages and what information should be in the corresponding method documentation in QuantumCircuit.

OK; do you want to put that comment on the epic? Then I'll close this issue and pick some others to start on?

beckykd avatar Oct 08 '24 13:10 beckykd

Sure. It'll pull in a few more files and classes than the epic lists (since not all of the gates feature in the top searches), but it's probably good to be consistent across the board.

jakelishman avatar Oct 08 '24 13:10 jakelishman