CPhaseGate parameter name mismatch in API docs

Qiskit / qiskit

Qiskit is an open-source SDK for working with quantum computers at the level of extended quantum circuits, operators, and primitives.

https://www.ibm.com/quantum/qiskit

Apache License 2.0

5.1k stars 2.34k forks source link

CPhaseGate parameter name mismatch in API docs #11809

Open marvin-richter opened 7 months ago

marvin-richter commented 7 months ago

URL to the relevant documentation

https://docs.quantum.ibm.com/api/qiskit/qiskit.circuit.library.CPhaseGate

Select all that apply

[X] typo
[ ] code bug
[ ] out-of-date content
[ ] broken link
[ ] other

Describe the fix.

Mismatch between theta as the parameter of the controlled phase-gate and $\lambda$ everywhere else on the page.

Eric-Arellano commented 7 months ago

Thanks, Marvin! I'm transferring this to the qiskit/qiskit repository because API doc changes need to happen there.

Would you be interested in fixing this? It looks like changing the docstring in https://github.com/Qiskit/qiskit/blob/9184907e1cc9b8563186a559d2e446518bbe8fac/qiskit/circuit/library/standard_gates/p.py#L159.

cameron-d28 commented 16 hours ago

@Eric-Arellano for this issue would the solution be to change 1) the parameter or 2) the notation in the representation. i would assume change 2 as it would keep the parameter for many of the gates as theta rather than having theta be confused with lamda in the params.

cameron-d28 commented 16 hours ago

could i also please be assigned this?