documentation icon indicating copy to clipboard operation
documentation copied to clipboard

Attributes section header is going in the incorrect place

Open Eric-Arellano opened this issue 1 year ago • 0 comments

For some of the Circuit Library functions, the parameters for the class constructor appear underneath the header "Attributes". This happens in both Sphinx and our repository, such as the 1.3 docs for qiskit.circuit.library.PhaseGate.

Image

Note that these parameters don't have any docstring associated with them. This problem was detected in https://github.com/Qiskit/documentation/pull/2418, which adds parameters with no docstring. Maybe this happens in that specific edge case where there aren't documented parameters?

Eric-Arellano avatar Dec 02 '24 20:12 Eric-Arellano